docs: update project structure listing to match current classic template#12284
docs: update project structure listing to match current classic template#12284TejasAmle wants to merge 1 commit into
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
|
Hi @TejasAmle! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Pre-flight checklist
Motivation
I followed the installation guide as a first-time user would. The Project structure section says "you will see the following files generated", but the tree it shows (
docs/doc1.mdx,blog/2019-05-28-hola.mdx,yarn.lock, …) is from the early v2-alpha template and hasn't matched the output ofnpx create-docusaurus@latest my-website classicsince theintro+tutorial-basicstemplate shipped in 2021.Who this affects: brand-new users, at the single most confidence-sensitive moment of adoption. You scaffold a site, open the folder next to the docs, and none of the listed files exist — while files the docs don't mention (
docs/tutorial-basics/,blog/authors.yml,src/components/) do. The natural first reaction is "did I run the wrong command / wrong template?", not "the docs are stale". Since this is the page CONTRIBUTING.md points newcomers at first, the mismatch also undercuts trust in the rest of the guide.This PR updates the tree to what the classic (JavaScript) template actually generates today. Notable corrections beyond filenames:
yarn.lockremoved — the scaffold itself writes no lockfile; which one appears after install depends on the package manager used..gitignore,blog/authors.yml,blog/tags.yml,src/components/, and thedocs/tutorial-*folders added — these are generated and previously undocumented here.The same stale tree exists in every
versioned_docs/version-*/installation.mdxback to 2.x. Per the CONTRIBUTING guidance on not editing versioned docs, I've left those untouched — happy to also patch the latest version's copy in this PR if you'd prefer, since that's the page most visitors actually read.Test Plan
npx create-docusaurus@latest my-website classic(create-docusaurus /@docusaurus/core3.10.2, Node 22) and comparedfind my-website -type foutput against the new tree — matches.maintemplates (packages/create-docusaurus/templates/classic+shared) generate the same set of files, so the listing is correct fornextas well.npm install+npm run buildon the scaffolded site complete successfully (verifying the surrounding sections of the page still hold).oxfmt --list-different website/docs/installation.mdxreports no issues.Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/docs/next/installation#project-structure