Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Documentation: Split docs site into 'CLI' and 'Engine' #123

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jan 8, 2025 · 1 comment · Fixed by #131
Closed
2 tasks done

📝 Documentation: Split docs site into 'CLI' and 'Engine' #123

JoshuaKGoldberg opened this issue Jan 8, 2025 · 1 comment · Fixed by #131
Assignees
Labels
area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏
Milestone

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

Overview

Documenting a tool like create is tricky because there are really two tools in one:

  • The CLI: what 99.99999% of users care about
  • The underlying engine: where much of the complexity and concepts reside

Right now the docs sidebar tree only kind of reflects that. CLI information is all root-level; engine information is inside a collapso:

Screenshot of the create.bingo site sidebar with About, CLI, Configuration, FAQs, and Glossary as root-level pages, and 'Templating Engine' as an expanded folder with multiple children

But I think these should be separated even more. I think there should be two docs sections: one for CLI and one for Engine.

Additional Info

For reference, typescript-eslint.io has a similar split right now between Docs and Rules.

I'm separately ramping up on the Yeoman/Yo project and am now wondering if this same split is why they have an explicitly different name for the core project ("yeoman") and the CLI ("yo")...

💝

@JoshuaKGoldberg JoshuaKGoldberg added area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏 labels Jan 8, 2025
@JoshuaKGoldberg JoshuaKGoldberg added this to the Blocks Launch milestone Jan 8, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 8, 2025
@JoshuaKGoldberg
Copy link
Owner Author

This isn't yet natively supported in Starlight core: withastro/starlight#959. withastro/starlight#687 (comment) suggests using component overrides.

Alternately, comments in that discussion point to some userland approaches. I like the look of https://github.com/HiDeoo/starlight-sidebar-topics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to documentation ("docs") status: accepting prs Please, send a pull request to resolve this! 🙏
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant