docs: update most of the docs #399
Open
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR restructures the documentation by breaking down content from the main README into separate documentation files. The goal is to create a more organized documentation structure where the README serves as a project summary with links to detailed documentation files.
- Moved installation instructions from README to dedicated installation.md file
- Created separate configuration guides for VS Code, Neovim, and Emacs
- Enhanced existing documentation with Quick Start sections and improved table of contents
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/vscode-configuration.md | New comprehensive VS Code configuration guide with settings, commands, and examples |
| docs/usage.md | Updated with table of contents and Quick Start section, fixed installation link reference |
| docs/neovim-configuration.md | Enhanced with Quick Start section and detailed table of contents structure |
| docs/lsp-spec.md | Added table of contents with proper navigation structure |
| docs/installation.md | New comprehensive installation guide covering all platforms and methods |
| docs/emacs-configuration.md | New detailed Emacs configuration guide with setup instructions and examples |
| docs/CONTRIBUTING.md | Major restructuring with improved organization, table of contents, and consolidated build instructions |
| README.md | Streamlined by moving detailed installation/usage content to separate docs, added references to new documentation files |
| .github/PULL_REQUEST_TEMPLATE.md | Enhanced template with change type checklist and contribution guidelines |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
docs: consolidate docs, add Quick Start and format Merge and clean docs: added Quick Start sections to editor and installation docs, simplified CONTRIBUTING references to scripts, formatted markdown with Prettier. docs: refactor all of docs, add toc's, link them from README.md Update docs/vscode-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update docs/lsp-spec.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update docs/emacs-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> fix: installation docs, todo comment Update docs/lsp-spec.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update docs/CONTRIBUTING.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> chore: final update
0e67e63 to
69c0092
Compare
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 feel like breaking the README file to multiple pieces, or better, create a docs website. Our docs are getting bigger day by day, and is scattered across the repo.
@cordx56 We need some work on this, what do you think?
As code is humongous, every piece of code should have its own documentation, and we can link to it from the main README file. README would be a summary of the project, and then we can have a docs website with all the details.