Documentation Updates for v0.6.5

[ramonpzg]

Documentation Updates for v0.6.5

Summary

• Added: v0.6.5 changelog with release highlights
• Added: MCP tutorial examples (E2B Code Sandbox, Exa Search)
• Reorganized: Documentation structure for improved navigation
• Updated: Multiple pages for better readability and user experience

Key Changes

• Changelog: Added 2025-07-17-responsive-ui.mdx with v0.6.5 release notes
• MCP Examples: Created comprehensive tutorials for E2B and Exa MCP integrations with screenshots
• Documentation Polish: Rewrote model parameters, llama.cpp, troubleshooting, and settings pages with clearer, more accessible language
• Structure: Moved server examples from /server-examples/ to /local-server/ root for better organization
• Assets: Added screenshots and images for new tutorials

Improvements

• Added practical, real-world examples and use cases
• Improved troubleshooting guides with step-by-step solutions
• Enhanced accessibility for both technical and non-technical users

---

Important

Documentation updates for v0.6.5 include new tutorials, reorganized structure, and improved readability, along with a new changelog entry.

• Documentation Structure:
  • Reorganized documentation for better navigation, moving server examples to /local-server/.
  • Added new sections for Jan Local Server and MCP Examples.
• Changelog:
  • Added 2025-07-17-responsive-ui.mdx with v0.6.5 release notes.
• Tutorials:
  • Added E2B Code Sandbox and Exa Search MCP tutorials with setup instructions and examples.
• Content Updates:
  • Updated llama-cpp.mdx and model-parameters.mdx for clearer language and better accessibility.
  • Enhanced troubleshooting.mdx with detailed steps for common issues.
• Assets:
  • Added new images and screenshots for tutorials and changelog.

^{This description was created by for 2f77c6b. You can customize this summary. It will automatically update as commits are pushed.}

[github-actions]

Preview URL: https://3deee7f6.docs-9ba.pages.dev

[ellipsis-dev]

Caution

Changes requested ❌

Reviewed everything up to 2f77c6b in 2 minutes and 56 seconds. Click for details.

• Reviewed 2795 lines of code in 24 files
• Skipped 128 files when reviewing.
• Skipped posting 7 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. docs/src/pages/docs/llama-cpp.mdx:67

• Draft comment:
  Ensure backend variant names and CUDA version details remain up-to-date with the latest supported hardware.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% This comment is asking the PR author to ensure that certain details remain up-to-date, which falls under the rule of not asking the author to ensure things. It doesn't provide a specific suggestion or point out a specific issue with the code.

2. docs/theme.config.tsx:76

• Draft comment:
  Double-check navigation labels: 'Jan Local Server' vs. 'Jan API Platform'. Confirm that the intended links are correctly assigned.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the PR author to confirm their intention regarding navigation labels, which violates the rule against asking for confirmation of intention. It does not provide a specific code suggestion or ask for a specific test to be written.

3. docs/src/pages/local-server/troubleshooting.mdx:268

• Draft comment:
  Verify that the permission-fix command examples work across platforms; consider testing or adding platform-specific notes.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the PR author to verify and test the command examples across platforms, which violates the rule against asking the author to ensure the change is tested or to double-check things. It doesn't provide a specific suggestion or point out a specific issue with the code.

4. docs/src/pages/local-server/tabby.mdx:41

• Draft comment:
  Clarify if extra configuration is required for connecting Jan with Tabby beyond the steps shown.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50% None

5. docs/src/pages/changelog/2025-07-17-responsive-ui.mdx:21

• Draft comment:
  Typographical error: The phrase "can causes" should be corrected to "can cause".
• Reason this comment was not posted:
  Marked as duplicate.

6. docs/src/pages/docs/mcp-examples/data-analysis/e2b.mdx:148

• Draft comment:
  Typo: The phrase "we're to get this fixed" might be clearer as "we'll get this fixed". Consider revising for clarity.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50% While this is technically correct and the text is in a changed file (new file), our rules state that we should not make purely informative comments. The meaning is clear despite the minor grammatical error, and this kind of small typo doesn't impact code functionality or documentation clarity in a meaningful way. The grammar error could potentially confuse non-native English speakers. The comment does provide a clear fix. While true, the meaning is still understandable and this is the kind of minor issue that clutters PR reviews without adding significant value. Delete the comment as it's too minor and doesn't affect understanding or functionality significantly.

7. docs/src/pages/local-server/settings.mdx:56

• Draft comment:
  Consider checking the file name in the image reference: 'trouble-shooting-04.png' might be intended to be 'troubleshooting-04.png' for consistency with the term used elsewhere.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50% While the comment points out a real inconsistency in spelling between the image name and the guide name, this is a relatively minor issue. The image will still work either way. The rules say not to make comments that are obvious or unimportant. This feels like a minor stylistic suggestion rather than a substantive issue requiring a code change. The inconsistency could cause confusion or maintenance issues down the line. Having consistent naming conventions is a good software practice. While consistency is good, this is too minor of an issue to warrant a PR comment. The image works fine either way, and this kind of minor cleanup can be handled in a separate maintenance PR if desired. Delete this comment as it points out a minor stylistic inconsistency that doesn't materially impact the functionality or maintainability of the code.

Workflow ID: wflow_LOx7OIOidrayIAhc

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}

[louis-jan]

LGTM