[DRAFT] Add documentation #117
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds the table of contents for the Rendezvous docs.
moodmosaic
reviewed
Feb 19, 2025
There was a problem hiding this comment.
This looks good! Thank you @BowTiedRadone. I think the nested layout can easily get out of sync? I was thinking having a flat structure like https://github.com/moodmosaic/bookmarks. Easy to scan, harder to accidentally break. Also, users no longer read the web, they scan it and perhaps a flat layout is easier. What do you think?
|
After some consideration, we'll try https://rust-lang.github.io/mdBook/. |
Initialized `mdbook` in `docs/`, tweaking `book.toml` to fit our flat layout. Renamed `book/` to `dist/`, since that's where built assets go (GitHub Pages friendly). Instead of `src/`, we keep markdown files in the root for clarity. Now, anyone browsing `docs/` can actually see the docs—whether they read the book or just skim the pages.
Inserted placeholder content for all sections to outline a possible structure. Adopted a flat directory layout temporarily, to simplify navigation and organization.
BowTiedRadone
commented
Feb 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the Rendezvous documentation. It is still a draft. Resolves #108.