Skip to content

Add documentation #117

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Mar 6, 2025
Merged

Add documentation #117

merged 8 commits into from
Mar 6, 2025

Conversation

BowTiedRadone
Copy link
Collaborator

This PR adds the Rendezvous documentation. It is still a draft. Resolves #108.

moodmosaic
moodmosaic reviewed Feb 19, 2025
View reviewed changes
Copy link
Member

@moodmosaic moodmosaic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@moodmosaic
Copy link
Member

After some consideration, we'll try https://rust-lang.github.io/mdBook/.

BowTiedRadone
BowTiedRadone commented Feb 20, 2025
View reviewed changes
Copy link
Collaborator Author

@BowTiedRadone BowTiedRadone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic! The structure is exactly what we need! I'm pretty sure we can start adding text content to the docs from this point 🚀

@moodmosaic
Copy link
Member

This is in a good state where we can start andding items from #108. For consistency, let’s format code examples as follows:

  • What situation triggers the example.
  • Why it’s needed.
  • How to use it.
  • What is the outcome.

These serve as implicit guidelines to maintain flow. Explicit sections are unnecessary.

Also, I’d keep content concise; users always scan rather than read in detail.

@BowTiedRadone BowTiedRadone force-pushed the docs branch 8 times, most recently from c227931 to 2e780a5 Compare February 25, 2025 16:47
@moodmosaic
Copy link
Member

Note to self to add acknowledgments in the doc. 🗒️

moodmosaic
moodmosaic reviewed Feb 26, 2025
View reviewed changes
Copy link
Member

@moodmosaic moodmosaic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Massive 🚀 I'll submit a few smaller reviews than a single fairly-sized one.

moodmosaic
moodmosaic reviewed Feb 26, 2025
View reviewed changes
BowTiedRadone added a commit that referenced this pull request Feb 26, 2025
@BowTiedRadone
Simplify invariant running explanation
dc6b7da 
This commit addresses #117 (comment)
moodmosaic
moodmosaic reviewed Feb 26, 2025
View reviewed changes
@moodmosaic moodmosaic changed the title [DRAFT] Add documentation Add documentation Mar 4, 2025
@moodmosaic moodmosaic marked this pull request as ready for review March 4, 2025 13:25
@moodmosaic moodmosaic requested a review from a team as a code owner March 4, 2025 13:25
BowTiedRadone
BowTiedRadone commented Mar 4, 2025
View reviewed changes
Copy link
Collaborator Author

@BowTiedRadone BowTiedRadone left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work! I love to see how the docs are becoming real! Left a few comments. 🚀

BowTiedRadone
BowTiedRadone commented Mar 5, 2025
View reviewed changes
Copy link
Collaborator Author

@BowTiedRadone BowTiedRadone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing the comments! Left only one more comment. After that, I'm confident we can press the merge button 🥇

moodmosaic and others added 3 commits March 6, 2025 08:54
@moodmosaic @BowTiedRadone
Add placeholders for each section in the docs/
943b378 
Inserted placeholder content for all sections to outline a possible
structure. Adopted a flat directory layout temporarily, to simplify
navigation and organization.

Co-authored-by: BowTiedRadone <[email protected]>
@moodmosaic @BowTiedRadone
Update docs/chapter_2.md
9762365 
Co-authored-by: BowTiedRadone <[email protected]>
@moodmosaic @BowTiedRadone
Update docs/chapter_3.md
6bdd2c1 
Co-authored-by: BowTiedRadone <[email protected]>
moodmosaic and others added 5 commits March 6, 2025 08:56
@moodmosaic @BowTiedRadone
Update docs/chapter_4.md
d6c5fc7 
Co-authored-by: BowTiedRadone <[email protected]>
@moodmosaic @BowTiedRadone
Update docs/chapter_5.md
52ed452 
Co-authored-by: BowTiedRadone <[email protected]>
@BowTiedRadone @moodmosaic
Update docs/chapter_6.md
7d3ab10 
Co-authored-by: BowTiedRadone <[email protected]>
@BowTiedRadone @moodmosaic
Update docs/chapter_7.md
b5a8881 
Co-authored-by: BowTiedRadone <[email protected]>
@moodmosaic @BowTiedRadone
Housekeeping docs/
a2bc65b 
- Move CONTRIBUTING.md inside docs/
- Update title
- Change code block appearance without overwriting the whole style
- Update code block border CSS to more neutral color
- Add TOC to Chapter 6

Co-authored-by: BowTiedRadone <[email protected]>
@moodmosaic
Copy link
Member

All review comments addressed, rebased. Ready for final round of review.

@BowTiedRadone
Copy link
Collaborator Author

Double checked everything. The docs are ready to be merged! 🤺 🚀

@BowTiedRadone BowTiedRadone requested a review from moodmosaic March 6, 2025 08:42
@moodmosaic moodmosaic merged commit 5f9c64e into master Mar 6, 2025
21 checks passed
@moodmosaic moodmosaic deleted the docs branch March 6, 2025 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@moodmosaic moodmosaic moodmosaic approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Usage documentation
2 participants
@BowTiedRadone @moodmosaic