docs: consolidate, update and extend documentation #967
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
sebthom
force-pushed
the
docs
branch
2 times, most recently
from
82a3696 to
6d1077f
Compare
Member
Author
|
@mickaelistria @angelozerr this is a substantial upgrade to the documentation. I hope you are fine with this PR. I don't expect you to read and verify every line but a general OK would be appreciated. |
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
angelozerr
reviewed
Nov 24, 2025
Contributor
Of course I am more than fine with it. That's highly valuable work! |
Contributor
|
@sebthom I have add few comments. Thanks so much for your work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
This change migrates and unifies documentation from the GitHub Wiki, the legacy documentation/ folder, README.md, and CONTRIBUTING.md into a coherent set of guides under docs/.
The content is organized by target audience (end users, plug‑in developers, and TM4E contributors), refreshed where it was outdated, and extended with details on internals such as Generic Editor integration, async tokenization, folding, diagnostics, and the release process.
After this is merged, the GitHub Wiki will be disabled so that all documentation changes go through the normal PR review workflow.
Fixes #954