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

(WIP) docs revamp. #1275

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

(WIP) docs revamp. #1275

wants to merge 10 commits into from

Conversation

raulk
Copy link
Contributor

@raulk raulk commented Feb 11, 2025

This reorganizes our docs tree in the following ways:

  • Merges inner docs subtrees into a top level docs folder
  • Restructures the site docs (docs.ipc.space) into these sections:
    • Overview (could be Introduction)
    • Concepts
    • Getting Started (Setup)
    • Develop (developer guides)
    • Usage (user guides)
    • Troubleshooting
    • Reference (API, SDK, CLI...)
    • Specs (a symlink to docs/specs)

TODO

  • Discuss and align on final structure
  • Establish redirects from old content to new content (pretty bad for SEO to destroy links)
  • Revisit all existing content and re-write/improve/deprecate
  • Decide which pieces of new content we need and track those separately

Closes #1287


This change is Reviewable

@raulk raulk requested a review from a team as a code owner February 11, 2025 18:32
@raulk raulk marked this pull request as draft February 11, 2025 18:32
@drahnr
Copy link
Contributor

drahnr commented Feb 12, 2025

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?

@raulk
Copy link
Contributor Author

raulk commented Feb 12, 2025

The changes look good, I'd tentatively convert the .PUML files to mermaid diagrams, which do have a textual representation

Agree, an LLM can probably do this for us.

The files are mostly moved from what I can see, do you intend to do a verification pass, them being still valid/correct?

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:

  • incorrect/outdated content
  • poorly communicated content
  • missing content

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.

@raulk raulk requested a review from LePremierHomme February 12, 2025 13:19
@LePremierHomme
Copy link
Contributor

Looks good, few suggestions:

  • move site/98-reference/faq.md into site/06-faq (and break sections into files)
  • simlink site/98-reference, similarly to specs.
  • add placeholder for dev section (not to be published)

@drahnr drahnr mentioned this pull request Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Backlog
Development

Successfully merging this pull request may close these issues.

reorganize docs tree and set up the publication workflow
3 participants