Skip to content

Restructures documentation and improves theme#27

Open
BraCR10 wants to merge 4 commits intoMostroP2P:mainfrom
BraCR10:feat/br/docs_improvement
Open

Restructures documentation and improves theme#27
BraCR10 wants to merge 4 commits intoMostroP2P:mainfrom
BraCR10:feat/br/docs_improvement

Conversation

@BraCR10
Copy link
Member

@BraCR10 BraCR10 commented Jan 24, 2026

  1. Improves documentation structure by grouping related topics into sections for better navigation.
  2. Enables folding in the sidebar to enhance navigation.

Closes #26

Note: Note: Please let me know if you have a different opinion about the section names, file placement, or whether this should be split into more sections.

Summary by CodeRabbit

  • New Features

    • Enabled collapsible section folding in HTML output for improved navigation.
    • Added support for applying a custom CSS theme for visual customization.
  • Style

    • Enhanced sidebar styling to improve visual hierarchy and readability of section titles.
  • Documentation

    • Reorganized documentation into clear, categorized sections for easier discovery and navigation.

Improves documentation structure by grouping related topics into sections for better navigation.

Enhances the visual appearance of the documentation by applying custom CSS for improved readability.

Enables folding in the sidebar to enhance navigation.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 24, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1f8b2100-7a52-407a-91b4-ae0035999ce7

📥 Commits

Reviewing files that changed from the base of the PR and between 305ed52 and b316358.

📒 Files selected for processing (1)
  • book.toml
🚧 Files skipped from review as they are similar to previous changes (1)
  • book.toml

Walkthrough

Enabled HTML folding and added a custom CSS theme; reorganized the documentation sidebar into structured top-level sections with nested items, without changing link targets.

Changes

Cohort / File(s) Summary
Configuration & Theme
book.toml, theme/custom.css
Added additional-css = ["theme/custom.css"] and [output.html.fold] enable = true, level = 0 to book.toml; added theme/custom.css with sidebar styling (white bold main section titles, light-gray bold expandable items, enforced with !important).
Documentation Structure
src/SUMMARY.md
Reorganized the flat sidebar into named sections (Introduction, Orders, Trading, Disputes, Communication, Admin Operations, Session Management, Protocol Reference) and nested items; link targets unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰
I hopped through toml and stitched some style,
Folded pages tidy, stacked them with a smile.
Sidebar titles gleam in bold delight,
Chapters curl up cozy, all snug and right.
A rabbit cheers — documentation takes flight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: reorganizing documentation into sections and improving the theme styling with CSS and folding configuration.
Linked Issues check ✅ Passed The pull request fulfills issue #26 by reorganizing SUMMARY.md into collapsible sections and enabling folding in book.toml configuration.
Out of Scope Changes check ✅ Passed All changes directly support the linked objective: SUMMARY.md restructuring addresses content organization, book.toml enables folding, and custom.css improves theme styling for the reorganized sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can generate a title for your PR based on the changes with custom instructions.

Set the reviews.auto_title_instructions setting to generate a title for your PR based on the changes in the PR with custom instructions.

BraCR10 and others added 2 commits January 23, 2026 21:35
Updates the `y` tag across all event examples to include the optional Mostro instance name.

Adds detailed documentation for NIP-01 kind 0 Node Identity metadata events and the new `days` field in user ratings.

Rewrites the Dispute Chat section to explain the NIP-59 encryption scheme and shared key establishment using ECDH.

Corrects field names in the session restoration documentation from `id` to `order_id`.
Copy link
Member

@Catrya Catrya left a comment

Choose a reason for hiding this comment

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

Hi @BraCR10, i tested it locally but there are no sections in the doc, i looks like the currently site, without sections

Image

@BraCR10
Copy link
Member Author

BraCR10 commented Mar 16, 2026

Hello, Locally it works

image

I ran:

just init
just serve

Removes a superfluous blank line for improved consistency.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation improvement

2 participants