Skip to content

Console docs#11

Merged
Nlea merged 12 commits intomainfrom
console-docs
Dec 11, 2025
Merged

Console docs#11
Nlea merged 12 commits intomainfrom
console-docs

Conversation

@Nlea
Copy link
Contributor

@Nlea Nlea commented Dec 11, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

Release Notes

  • Documentation

    • Added comprehensive Console docs: overview, getting started, review and evaluation guides, and examples for scoring/evals.
    • Updated MCP Gateway and MCP Lite docs with reorganized content and refined pages.
    • Added a Support page with community contact info.

  • Navigation

    • Restructured sidebar: new Console section with nested Core Functionality, updated MCP Gateway reference, and a Support section.

✏️ Tip: You can customize this high-level summary in your review settings.

Nlea and others added 10 commits December 4, 2025 10:43
@Nlea
WIP: docs reorganization
045fe02
@Nlea
Restructure mcp-gateway docs: consolidate into reference folder
d33de4f
@Nlea
docs(mcp-gateway): reorganize reference documentation
a7ce2a6 
- Consolidate all reference content into single reference.md page
- Move individual reference files from reference/ to references/
@Nlea @coderabbitai
Update src/content/docs/mcp-gateway/getting-started.mdx
f95ffaa 
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Nlea
minor fixes
4e16b25
@Nlea
init
5930b46
@Nlea
docs(console): improve review and getting-started documentation
7432187 
- Expand review.mdx with detailed report structure and clearer usage steps
- Convert getting-started.md to MDX format with comprehensive setup guide
- Update console index with key capabilities and quick start section
- Add structured table for review report sections
- Improve sharing and navigation instructions with examples
@Nlea
docs(console): expand evals documentation with comprehensive guidance
f5d3c5d
@brettimus
Update evals.md
e758016
@brettimus
Update the Console Overview page
0f31de5
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 11, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation and navigation were reorganized to introduce a new "Console" section with Core Functionality (Overview, Getting Started, Review, Evals), add a Support page, and update MCP Gateway and MCP Lite pages. Navigation config in astro.config.ts was updated to reflect these changes.

Changes

Cohort / File(s) Summary
Navigation & Config
astro.config.ts		 Rename top-level "MCP Lite" to "Console"; add nested "Core Functionality" group (Overview, Getting Started, Review, Evals); add Storage & Web UI to MCP Gateway Reference; add Support section with Discord link
Console docs (new)
src/content/docs/console/index.md, src/content/docs/console/getting-started.mdx		 Add Console overview and Getting Started guide covering prerequisites, server connection options, UI steps, and troubleshooting
Console docs (core functionality)
src/content/docs/console/core-functionality/review.mdx, src/content/docs/console/core-functionality/evals.md		 Add Review doc (evaluation dimensions, report format, generation and sharing steps) and Evals doc (scenarios, runs, scorers, TypeScript types, examples, LLM-based scoring)
Support
src/content/docs/support/index.md		 Add Support page with YAML front matter and placeholder content
Top-level docs updates
src/content/docs/index.mdx		 Simplify Getting Started intro to a single sentence; add "Fiberplane Console" quick link while keeping existing links
Existing docs edits
src/content/docs/mcp-gateway/index.md, src/content/docs/mcp-lite/index.mdx		 Update titles to "Overview MCP Gateway" and "Overview mcp-lite"; adjust mcp-lite example array formatting (multi-line/trailing comma) and remove front header in favor of front matter description

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Check astro.config.ts for correct nesting and link targets.
  • Verify front matter and cross-links in new docs (console/*, support/*).
  • Confirm title changes don't break navigation or internal references.

Possibly related PRs

  • Docs #10 — Related changes to astro.config.ts and MCP Gateway sidebar entries (Storage, Web UI).

Poem

🐰 I hopped through docs, rearranged the shelf,
Console gleams bright — I did it myself!
Evals and reviews now sit in a row,
Support and guides help the servers to grow.
✨🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Console docs' is vague and overly generic. While it refers to documentation additions for Console, it doesn't specify the main change—reorganization of the sidebar navigation, addition of Console documentation, or the reworking of MCP Gateway documentation. Use a more descriptive title that captures the primary change, such as 'Reorganize sidebar navigation and add Console documentation' or 'Add Console documentation with sidebar restructuring'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ec3a5c and eead9b0.

📒 Files selected for processing (9)
  • astro.config.ts (3 hunks)
  • src/content/docs/console/core-functionality/evals.md (1 hunks)
  • src/content/docs/console/core-functionality/review.mdx (1 hunks)
  • src/content/docs/console/getting-started.mdx (1 hunks)
  • src/content/docs/console/index.md (1 hunks)
  • src/content/docs/index.mdx (1 hunks)
  • src/content/docs/mcp-gateway/index.md (1 hunks)
  • src/content/docs/mcp-lite/index.mdx (2 hunks)
  • src/content/docs/support/index.md (1 hunks)

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.

@Nlea Nlea merged commit 611db0d into main Dec 11, 2025
1 check passed
@Nlea Nlea deleted the console-docs branch December 11, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Nlea @brettimus