-
Notifications
You must be signed in to change notification settings - Fork 45
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
(WIP) docs revamp. #1275
base: main
Are you sure you want to change the base?
(WIP) docs revamp. #1275
Conversation
- Learn - Deploy - Use - Develop - Operate - Troubleshoot - Specifications - Reference
The changes look good, I'd tentatively convert the .PUML files to mermaid diagrams, which do have a textual representation The files are mostly moved from what I can see, do you intend to do a verification pass, them being still valid/correct? |
Agree, an LLM can probably do this for us.
Definitely not correct -- we need to do a content pass. My initial focus was to contribute a skeleton that consolidated docs assets from all over the repo, and established a good outline/structure for the site. There's a lot of work to do here to get things cleaned up (championed by @LePremierHomme). We have:
I would, however, discourage a big-bang approach here. Would prefer to merge the skeleton with placeholders and dirty annotations (and even let that go live on the site), then systematically go through each item and improve through smaller, atomic PRs. |
Looks good, few suggestions:
|
This reorganizes our docs tree in the following ways:
TODO
Closes #1287
This change is