Improve-lix-docs #3762
Improve-lix-docs #3762
Conversation
…instead of lixcol_root_change_set_id
- Clarified the restoration process in the restore example. - Added a comprehensive "Getting Started" guide with installation and initialization steps. - Enhanced the "History" section to explain how history works and how to query it effectively. - Expanded the "How Lix Works" documentation to detail the storage layer, commit graph, and change control features. - Introduced a new "Plugins" section explaining how to use and build plugins for different file formats. - Created a "Querying Changes" guide to illustrate how to access current and historical data using SQL. - Removed the outdated "Quick Start" guide and replaced it with a more structured overview of Lix. - Added a new "What is Lix?" page summarizing the SDK's capabilities and features. - Updated various sections for clarity, consistency, and improved user guidance.
samuelstroschein
temporarily deployed
to
staging
GitHub Actions
Inactive
|
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run-many --nx-bail --target=build --parallel |
✅ Succeeded | 13s | View ↗ |
nx run-many --target=test --parallel |
✅ Succeeded | 10s | View ↗ |
nx run-many --target=lint --parallel |
✅ Succeeded | 1s | View ↗ |
☁️ Nx Cloud last updated this comment at 2025-11-23 18:48:58 UTC
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
… links, and fix restore documentation link
samuelstroschein
temporarily deployed
to
staging
GitHub Actions
Inactive
packages/lix/docs/rspress.config.ts
Outdated
| }, | ||
| { text: "JSON Plugin", link: "/docs/plugins/json" }, | ||
| { text: "CSV Plugin", link: "/docs/plugins/csv" }, | ||
| { text: "Markdown Plugin", link: "/docs/plugins/markdown" }, |
There was a problem hiding this comment.
Bug: Broken sidebar links to non-existent plugin pages
The sidebar configuration references plugin documentation pages under /docs/plugins/ (creating-plugins, json, csv, markdown), but the diff shows no corresponding files were created in src/docs/plugins/. The restructure moved files from docs/ to src/docs/, but these plugin pages appear to be missing entirely, causing broken navigation links.
packages/lix/docs/rspress.config.ts
Outdated
| { text: "Collaboration", link: "/examples/collaboration" }, | ||
| { text: "Building an App", link: "/examples/building-an-app" }, | ||
| { text: "Collaboration", link: "/docs/examples/collaboration" }, | ||
| { text: "Building an App", link: "/docs/examples/building-an-app" }, |
There was a problem hiding this comment.
Bug: Broken sidebar links to non-existent example pages
The sidebar configuration references example pages under /docs/examples/ (basic-usage, version-management, collaboration, building-an-app), but the diff shows no corresponding files were created in src/docs/examples/. These pages are referenced in the navigation but don't exist in the new structure, resulting in 404 errors when users click these links.
samuelstroschein
temporarily deployed
to
staging
GitHub Actions
Inactive
samuelstroschein
temporarily deployed
to
staging
GitHub Actions
Inactive
samuelstroschein
temporarily deployed
to
improve-lix-docs - lix-docs PR #3762
Render
Destroyed
samuelstroschein
temporarily deployed
to
staging
GitHub Actions
Inactive
| { text: "Diffs", link: "/docs/diffs" }, | ||
| { text: "Attribution (Blame)", link: "/docs/attribution" }, | ||
| { text: "Change Proposals", link: "/docs/change-proposals" }, | ||
| { text: "Validation Rules", link: "/docs/validation-rules" }, |
There was a problem hiding this comment.
Bug: Broken link to missing validation-rules documentation
The sidebar configuration references validation-rules at /docs/validation-rules, and lix-for-ai-agents.md links to ./validation-rules, but the actual file packages/lix/docs/src/docs/validation-rules.md is not included in this commit. The documentation restructure moved files around but appears to have missed creating or moving the validation-rules documentation file, resulting in broken navigation links and internal documentation references.
Additional Locations (1)
| { text: "Validation Rules", link: "/docs/validation-rules" }, | ||
| { text: "Undo/Redo", link: "/docs/undo-redo" }, | ||
| { text: "Restore", link: "/docs/restore" }, | ||
| { text: "Conversations", link: "/docs/conversations" }, |
There was a problem hiding this comment.
Bug: Missing conversations documentation file
The sidebar configuration references conversations at /docs/conversations, and multiple documentation files link to it (change-proposals.mdx at line 36 and 133, what-is-lix.md at line 14), but the file packages/lix/docs/src/docs/conversations.md is not included in this commit. This creates broken navigation links and internal documentation references throughout the restructured docs.
Additional Locations (2)
| { text: "Testing", link: "/docs/testing" }, | ||
| { text: "React Integration", link: "/docs/react-integration" }, | ||
| { text: "Logging & Debugging", link: "/docs/logging" }, | ||
| { text: "Deterministic Mode", link: "/docs/deterministic-mode" }, |
There was a problem hiding this comment.
Bug: Missing deterministic-mode documentation file
The sidebar configuration references deterministic-mode at /docs/deterministic-mode, but the file packages/lix/docs/src/docs/deterministic-mode.md is not included in this commit. This creates a broken navigation link in the sidebar.
| { text: "Logging & Debugging", link: "/docs/logging" }, | ||
| { text: "Deterministic Mode", link: "/docs/deterministic-mode" }, | ||
| { text: "Metadata", link: "/docs/metadata" }, | ||
| { text: "Writer Key", link: "/docs/writer-key" }, |
There was a problem hiding this comment.
Bug: Missing writer-key documentation file
The sidebar configuration references writer-key at /docs/writer-key, but the file packages/lix/docs/src/docs/writer-key.md is not included in this commit. This creates a broken navigation link in the sidebar.
|
|
||
| See the guide for the pattern, pitfalls, and a decision matrix: | ||
|
|
||
| - https://lix.dev/guide/writer-key |
There was a problem hiding this comment.
Bug: Outdated absolute URL to old documentation structure
The react-integration documentation contains an absolute URL https://lix.dev/guide/writer-key that points to the old documentation structure at /guide/writer-key. After this restructure, the URL should point to /docs/writer-key instead. This link will be broken once the restructure is deployed, even if the writer-key.md file is eventually added.
Note
Restructures and expands the Lix docs into a new flat, conversion‑focused site with updated navigation, examples, and API docs paths; also tweaks SDK docs/comments and tests.
src/docs/with flat sections: Getting Started, Essentials, Guides, and API Reference.how-lix-works,data-model,history,diffs,persistence,plugins,lix-for-ai-agents, etc.) and componentcomponents/code-snippet.tsx..gitignorefor new docs paths.src/, regenerates API docs tosrc/docs/api, and updates sidebar/nav links to/docs/....docs/react-integration.mdx.openLix.toBlob()JSDoc with examples and.lixconvention.file_historyusage and scopes inapplyFileDatabaseSchema; minor test/comment adjustments for history queries.Written by Cursor Bugbot for commit e2f1f74. This will update automatically on new commits. Configure here.