Skip to content

docs: refresh README and organize user documentation - #463

Merged
lwu1822 merged 3 commits into
petertzy:mainfrom
Aaqibhafeezkhan:issue-460/documentation-refresh
Nov 5, 2026
Merged

lwu1822 merged 3 commits into
petertzy:mainfrom
Aaqibhafeezkhan:issue-460/documentation-refresh

Conversation

@Aaqibhafeezkhan

@Aaqibhafeezkhan Aaqibhafeezkhan commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Refresh the README with an accurate project overview, current installation instructions, feature highlights, and links to detailed documentation.
  • Add dedicated user, project workflow, and keyboard shortcut guides.
  • Document Focus Mode, AI-assisted editing, local Notes Context, provider configuration, and data-handling considerations.
  • Document project translation, failed-file retries, reviewable multi-file AI changes, and publication preparation.
  • Update platform-specific PDF export instructions and technical documentation.
  • Correct outdated hosting, release signing, and checksum information.
  • Reorganize the documentation index and MkDocs navigation.
  • Update contributor setup instructions while preserving useful existing technical and planning documentation.

The documentation has been cross-checked against the current frontend, backend, configuration, and release workflows.

Closes #460.

@Aaqibhafeezkhan Aaqibhafeezkhan left a comment •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Aaqibhafeezkhan
Aaqibhafeezkhan force-pushed the issue-460/documentation-refresh branch 3 times, most recently from 84f5dcd to 282f9b3 Compare November 3, 2026 22:59
@Aaqibhafeezkhan
Aaqibhafeezkhan force-pushed the issue-460/documentation-refresh branch from 282f9b3 to 4b5eaa7 Compare November 3, 2026 23:00
@lwu1822
lwu1822 self-requested a review November 4, 2026 05:37

@lwu1822 lwu1822 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment thread docs/UserGuide.md Resolved
Comment thread docs/KeyboardShortcuts.md Resolved
Comment thread docs/UserGuide.md Resolved
@lwu1822

lwu1822 commented Nov 5, 2026

Copy link
Copy Markdown
Collaborator

Thanks for addressing the feedback! The previous blocking concerns are resolved and it LGTM.

@lwu1822
lwu1822 merged commit 153ffe9 into petertzy:main Nov 5, 2026
2 checks passed
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.

Update Project Documentation to Reflect Recent Major Changes and Improve README Organization

2 participants