Require Docusaurus-friendly section index pages

gravitational / docs

Source code backing goteleport.com/docs

https://goteleport.com/docs

Apache License 2.0

11 stars 13 forks source link

Require Docusaurus-friendly section index pages #500

Closed ptgott closed 3 weeks ago

ptgott commented 1 month ago

If a directory has no section index page within it that is named after the directory, e.g., dir1/dir2/dir2.mdx, throw an exception when building the docs.

Currently, the docs engine also allows a section index page at the same level as its corresponding directory, since this is a convention the docs content has followed. However, this leads to undesired output when building the site with Docusaurus.

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 30, 2024 10:21pm