Skip to content

Add documentation site + refresh crate READMEs#110

Merged
Sewer56 merged 2 commits intomainfrom
improve-readme-new-new
Apr 24, 2026
Merged

Add documentation site + refresh crate READMEs#110
Sewer56 merged 2 commits intomainfrom
improve-readme-new-new

Conversation

@Sewer56
Copy link
Copy Markdown
Member

@Sewer56 Sewer56 commented Apr 24, 2026

This adds a proper documentation site for the project and brings all the crate READMEs up to date.

New: MkDocs site (docs/)

  • 12 pages covering agents, tools, sandboxing, getting started, etc.
  • Custom dark theme, GitHub Pages deploy workflow, local dev helper

Rewrite: READMEs

  • Top-level README repositioned as "OpenCode for servers"
  • All crate READMEs: consistent links, expanded permission docs, updated model examples

Fix: API docs

  • Missing #[doc] links on public fs functions
  • Stale intra-doc links in loader.rs

Minor: fixture punctuation, Cargo.lock, .gitignore

45 files, +3,490 −167

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 2026

Warning

Rate limit exceeded

@Sewer56 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 45 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 55 minutes and 45 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6c8e0c91-eb30-4040-91e1-f18373f4e527

📥 Commits

Reviewing files that changed from the base of the PR and between b3c8519 and ac64d74.

⛔ Files ignored due to path filters (1)
  • src/Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (39)
  • .github/workflows/deploy-mkdocs.yml
  • .gitignore
  • README.MD
  • SANDBOX-PROFILES.md
  • docs/.gitignore
  • docs/mkdocs.yml
  • docs/requirements.txt
  • docs/src/agents.md
  • docs/src/architecture.md
  • docs/src/assets/landing.css
  • docs/src/comparison.md
  • docs/src/examples.md
  • docs/src/feature-flags.md
  • docs/src/getting-started.md
  • docs/src/guides/custom-framework.md
  • docs/src/index.md
  • docs/src/migration.md
  • docs/src/models-catalog.md
  • docs/src/sandboxing.md
  • docs/src/tools.md
  • docs/src/vendor/Reloaded/Images/Nexus-Heart-40.avif
  • docs/src/vendor/Reloaded/Images/Nexus-Icon-40.avif
  • docs/src/vendor/Reloaded/Images/Reloaded-Heart-40.avif
  • docs/src/vendor/Reloaded/Images/Reloaded-Icon-40.avif
  • docs/src/vendor/Reloaded/Stylesheets/reloaded.css
  • docs/start_docs.py
  • src/llm-coding-tools-agents/ARCHITECTURE.md
  • src/llm-coding-tools-agents/Cargo.toml
  • src/llm-coding-tools-agents/README.md
  • src/llm-coding-tools-agents/benches/fixtures/orchestrator-quality-gate-gpt5.md
  • src/llm-coding-tools-agents/src/runtime/mod.rs
  • src/llm-coding-tools-agents/src/runtime/model.rs
  • src/llm-coding-tools-bubblewrap/ARCHITECTURE.md
  • src/llm-coding-tools-bubblewrap/README.md
  • src/llm-coding-tools-core/README.md
  • src/llm-coding-tools-models-dev/README.md
  • src/llm-coding-tools-serdesai/AGENTS-ARCHITECTURE.md
  • src/llm-coding-tools-serdesai/README.md
  • src/llm-coding-tools-serdesai/src/agent_ext.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch improve-readme-new-new

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.

@Sewer56 Sewer56 force-pushed the improve-readme-new-new branch from e0e51a0 to ac64d74 Compare April 24, 2026 18:16
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.98%. Comparing base (b3c8519) to head (ac64d74).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #110      +/-   ##
==========================================
- Coverage   81.04%   80.98%   -0.07%     
==========================================
  Files         110      110              
  Lines        4517     4517              
==========================================
- Hits         3661     3658       -3     
- Misses        856      859       +3     
Flag Coverage Δ
async 80.22% <ø> (-0.07%) ⬇️
blocking 58.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/llm-coding-tools-agents/src/runtime/model.rs 68.42% <ø> (ø)
src/llm-coding-tools-serdesai/src/agent_ext.rs 55.55% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Sewer56 Sewer56 merged commit ceb46b6 into main Apr 24, 2026
22 checks passed
@Sewer56 Sewer56 deleted the improve-readme-new-new branch April 24, 2026 18:27
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.

1 participant