docs: initialize developer docs directory - #317
Merged
Conversation
4 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Initializes a top-level docs/ directory intended for developer/maintainer documentation after the website was moved under website/, reducing ambiguity in the repo layout (tracked under #305).
Changes:
- Adds a
docs/README.mdentry point and initial doc structure for key areas (setup, CI, VS Code extension, LSP). - Updates the website developer documentation page heading/structure under
docs/website.md. - Adds a WIP notice to the existing LSP name resolution doc.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/website.md | Reframes website documentation with a top-level title and development section. |
| docs/vscode.md | Adds placeholder page for VS Code extension docs. |
| docs/setup.md | Adds placeholder setup page. |
| docs/README.md | Adds docs index with links to the initial documentation structure. |
| docs/lsp/README.md | Adds placeholder LSP documentation index. |
| docs/lsp/definition-resolution.md | Adds a WIP/draft notice to an existing technical doc. |
| docs/developer-guide.md | Adds placeholder developer guide page. |
| docs/ci.md | Adds placeholder CI documentation page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Initialize the top-level
docs/directory for developer and maintainer documentation.The previous
docs/name was used by the website, which made the repository layout confusing. After moving the website intowebsite/, this PR adds a real developer docs directory with a small initial structure.Note that most files are placeholders for now. The actual content will be filled in incrementally.
This is a part of directory layout refactor. See #305