Improve SEO: PyPI keywords, alternatives comparison, docs site#28
Merged
Conversation
- Expand PyPI keywords in packages/core/pyproject.toml with search-intent terms (docx-comparison, compare-word-documents, track-changes-api, python-docx-diff, legal-tech, docxodus) and a search-friendly package description; add Documentation/Demo project URLs. - Add docs/alternatives.md comparing Python-Redlines to Draftable API, Cloudmersive, and server-side MS Word automation, with a condensed version linked from the README. - Add a hyper-focused tutorial: docs/tutorials/how-to-compare-word-documents-python.md. - Stand up a MkDocs (Material) static docs site: mkdocs.yml, docs/index.md with SoftwareApplication JSON-LD schema markup, auto-generated sitemap.xml, and a GitHub Pages deploy workflow. - Link the redlines.opensource.legal demo site from the README and docs homepage.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
packages/core/pyproject.tomlwith search-intent terms (docx-comparison,compare-word-documents,track-changes-api,python-docx-diff,legal-tech,docxodus), a search-friendly package description, andDocumentation/Demoproject URLs.docs/alternatives.md: a detailed, indexable comparison of Python-Redlines vs. Draftable API, vs. Cloudmersive, and vs. server-side MS Word automation (TOS risk, cloud costs, data privacy). Condensed version linked from the README.docs/tutorials/how-to-compare-word-documents-python.md, targeting "how to compare two Word documents programmatically in Python".mkdocs.yml,docs/index.mdwithSoftwareApplicationJSON-LD schema markup, auto-generatedsitemap.xml, and a.github/workflows/docs.ymlGitHub Pages deploy workflow.Verified
mkdocs build --strictsucceeds cleanly and both the sitemap and JSON-LD schema render as expected.Not included (needs a repo admin, no API for it here)
docx,redline,tracked-changes,docx-comparison,compare-word-documents,track-changes-api,python-docx-diff,legal-tech,openxml,docxodus.docs.ymlworkflow runs once (creating agh-pagesbranch), enable Pages in repo Settings → Pages → deploy from thegh-pagesbranch, sohttps://jsv4.github.io/Python-Redlines/goes live.Test plan
mkdocs build --strict— passes, no broken links or missing configsite/sitemap.xmllists all docs pages with the configuredsite_urldocs/index.mdrenders itsSoftwareApplicationJSON-LD<script>tag in the built HTMLdocs.ymlworkflow deploys successfully and Pages serves the site once enabled in repo settingsGenerated by Claude Code