Document how to install optional dependencies #155
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation by adding clear instructions for installing optional DOCX dependencies, addressing issue #149. The changes improve user guidance by explicitly documenting the pip install rtflite[docx] command for end users and uv sync --extra docx for developers. Additionally, the PR includes minor fixes to the changelog, correcting a spelling error ("packging" → "packaging") and cleaning up trailing whitespace.
Key changes:
- Added "Optional dependencies - DOCX support" sections to README.md and docs/index.md with installation instructions
- Added Prerequisites section to the assemble article with DOCX installation instructions
- Fixed spelling error in changelog files and improved documentation structure
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added new section documenting how to install optional DOCX dependencies with both pip and uv commands |
| docs/index.md | Added identical DOCX installation instructions as README.md for consistency |
| docs/articles/assemble.md | Added Prerequisites section for DOCX installation and improved heading structure (changed comment-style headings to proper markdown section headings) |
| CHANGELOG.md | Fixed spelling error ("packging" → "packaging") and removed trailing whitespace |
| docs/changelog.md | Applied identical spelling and whitespace fixes as CHANGELOG.md |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #149
This PR updates
README.mdand the assemble article on how to install thedocxextra.