Repository navigation
docs: refresh README and organize user documentation - #463
Conversation
There was a problem hiding this comment.
Completed a deeper documentation audit against the recent upstream changes and current application implementation. Updated the README and detailed guides, corrected outdated project-opening, citation, hosting, and release information, and added documentation for Focus Mode, Notes Context, project translation, Project Work, and publication workflows. Also updated platform setup instructions and MkDocs navigation while retaining the existing technical and planning references.
84f5dcd to
282f9b3
Compare
282f9b3 to
4b5eaa7
Compare
lwu1822
left a comment
There was a problem hiding this comment.
Thanks for the documentation refresh! I appreciate the shorter README and separate guides, it makes the project easier to navigate. The explanations of other things like the project-change staging, translation retries, Notes Context data handling, and deterministic publication preparation are helpful.
I’m requesting changes for three documentation issues:
- The user guide describes audit-log and dedicated AI undo controls that are not exposed in the current frontend
- Several repository-relative links will break in the generated MkDocs site
- The PDF import description presents Docling as an available UI mode, although it is currently backend/API-only
These should be documentation corrections, no need to add these additional application features. Please address the inline comments before merge. Thank you very much!
|
Thanks for addressing the feedback! The previous blocking concerns are resolved and it LGTM. |
Summary
The documentation has been cross-checked against the current frontend, backend, configuration, and release workflows.
Closes #460.