Skip to content

docs: update project structure listing to match current classic template#12284

Open
TejasAmle wants to merge 1 commit into
facebook:mainfrom
TejasAmle:claude/docs-installation-project-structure
Open

docs: update project structure listing to match current classic template#12284
TejasAmle wants to merge 1 commit into
facebook:mainfrom
TejasAmle:claude/docs-installation-project-structure

Conversation

@TejasAmle

Copy link
Copy Markdown

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

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 of npx create-docusaurus@latest my-website classic since the intro + tutorial-basics template 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.lock removed — 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 the docs/tutorial-* folders added — these are generated and previously undocumented here.
  • Depth kept close to the original listing so the "Project structure rundown" below (which is still accurate) continues to line up.

The same stale tree exists in every versioned_docs/version-*/installation.mdx back 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

  • Ran npx create-docusaurus@latest my-website classic (create-docusaurus / @docusaurus/core 3.10.2, Node 22) and compared find my-website -type f output against the new tree — matches.
  • Confirmed the current main templates (packages/create-docusaurus/templates/classic + shared) generate the same set of files, so the listing is correct for next as well.
  • npm install + npm run build on the scaffolded site complete successfully (verifying the surrounding sections of the page still hold).
  • oxfmt --list-different website/docs/installation.mdx reports no issues.

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/docs/next/installation#project-structure

@meta-cla

meta-cla Bot commented Jul 14, 2026

Copy link
Copy Markdown

Hi @TejasAmle!

Thank you for your pull request and welcome to our community.

Action Required

In 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.

Process

In 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 CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@netlify

netlify Bot commented Jul 14, 2026

Copy link
Copy Markdown

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 3558294
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/6a55b201307fb80008705837
😎 Deploy Preview https://deploy-preview-12284--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant