Draft
Conversation
Member
|
Document translation implementation needs further research, and I prefer using VitePress for the documentation website because it offers a better browsing experience. |
Member
|
In order to ensure the documentation is easy to use, we must manually add a large number of examples and explanations. Simply generating the documentation from the source code is not feasible. |
Contributor
Author
Yes, sure. What I mean is that frequently changing things like config options and diagnostic codes can be documented in Rust source, and Sphinx will embed this documentation into markdown. This will help to keep everything up to date. |
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
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.
I've been working on documentation update.
I'm using Sphinx with Markdown (MySt) and my Lua plugin to automatically document emmyrc options and built-in types.
This is a very much work in progress, but all automation is done, what's left is to migrate current markdown documents. The last commit in this PR gets automatically deployed to https://taminomara.github.io/emmylua-analyzer-rust/en/
Note: language toggle works, but translation tables for Chinese are empty, so both versions are identical. I'll try to fill some of them from existing documents, but some help from community would be very much appreciated.
How's this better than current solution
.pofiles, meaning that it's easier to keep English and Chinese versions in sync.