Request for Documentation (RFD)

[Myriad-Dreamin]

Since lack of contributors, we focus on adding more functions instead of documenting everything. But tinymist has finished its software architecture since 0.12.2, it'll deserve to slow down development, refactor and add more documentation.

• tinymist-query (crates/tinymist-query)
  • LSP request crates (src/*.rs)
  • syntax crates (src/syntax/*.rs), containing AST-level analyzers.
  • type crates (src/type/*.rs), containing type definitions and operations.
  • analysis crates (src/analysis/*.rs), containing core analyzers based on syntax and type crates.
  • docs crates (src/docs/*.rs), containing docs utilities.
  • package crates (src/package/*.rs), containing package utilities.
• VS Code extension (editor/vscode)
  • main module (src/extension.ts), containing lifetime hooks and contributed commands.
  • lsp module (src/features/*.ts), containing lsp functions.
  • feature modules (src/features/*.ts), each of which is an extension feature.
• editor-tool (tools/editor-tools)
  • component modules (src/component/*.ts), each of which is a commonly-used component.
  • feature modules (src/features/*.ts), each of which is a tool page.

Since lack of contributors, we focus on adding more functions instead of documenting everything.

The above list of code is so long that people can request part of them to prioritize refactoring or documenting under this issue, so called "Request for Documentation".