Repository navigation
docs: mention availability of past documentation versions in README - #54
YDX-2147483647 wants to merge 1 commit into
Conversation
and add badges to make it easier to click. Also, since https://typst-docs-web.netlify.app/ja-jp/ becomes more visible, it is necessary to explain its relationship with https://typst-jp.github.io/docs/. Resolves typst-community#50
✅ Deploy Preview for typst-docs-web ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Thank you! I'll review it later. From a quick look, this direction seems fine. However, I think it might also be worth considering updating the description of typst-docs-web from just a static site generator to one that is both a static site generator and a hosted website. Also, while this is outside the scope of this PR, the subdirectory for netlify deployments should probably have noindex. At the very least, the ja-jp content should mainly be hosted on typst-jp. |
There was a problem hiding this comment.
Pull request overview
Updates project documentation and the Netlify-built landing page to make it clearer that the deployed example site can be used to browse multiple Typst documentation versions, and to add quick-access badges.
Changes:
- Add CI/Netlify/example-site status badges to the README.
- Add a README note pointing users to the Netlify example site for older Typst docs and to ZIM snapshots for the “original” layout.
- Update the Netlify index page’s ja-JP entry to include an upstream link to the Typst Japanese community site.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| scripts/netlify-build.sh | Adjusts generated Netlify index page content (ja-JP entry). |
| README.md | Adds badges and a tip about accessing multiple documentation versions via the Netlify example site. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <li><a href="./en-US-v0.14.0/">en-US, v0.14.0</a></li> | ||
| <li><a href="./en-US-v0.13.1/">en-US, v0.13.1</a></li> | ||
| <li><a href="./ja-JP/">ja-JP, v0.13.1</a></li> | ||
| <li><a href="./ja-JP/">ja-JP, v0.14.0</a> (upstream: <a href="https://typst-jp.github.io/docs/">Typst Japanese Community's website</a>)</li> |
and add badges to make it easier to click.
Also, since https://typst-docs-web.netlify.app/ja-jp/ becomes more visible, it is necessary to explain its relationship with https://typst-jp.github.io/docs/.
Resolves #50