Repository navigation
docs: overhaul documentation structure and add design documents - #291
Merged
Merged
Conversation
Migrate skills from .copilot/skills/ to .github/skills/ (SKILL.md agent spec). Move brainstorm.md, docmap.md, instructions to .github/. Add branch creation step to brainstorm workflow. Update all internal references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Reorganize docs by reader journey (overview → architecture → design/): - Add docs/overview.md: plugin introduction and key concepts - Add docs/getting-started.md + docs/contributing.md (split from development.md) - Simplify architecture.md to high-level layer overview with links to design docs - Add docs/README.md as documentation navigation page Add 8 why-first design documents under docs/design/: - psi-and-mixin.md: mixin pattern rationale, feature interfaces - symbol-resolution.md: two-phase resolve, scope hierarchy, root providers - stub-indexing.md: stub design tradeoffs, index types, external data - annotation-system.md: per-version annotators, validation philosophy - code-completion.md: provider-per-context model, insert handlers - compiler-system.md: in-process compiler rationale, plugin architecture - prototext.md: separate language design, schema linking - editions.md: feature-set model, migration from syntax versions Overhaul README.md: visual layout, feature highlights, Copilot workflow section. Add .intellijPlatform to .gitignore. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Mark brainstorm/docs-internals as Completed. Update ship skill: final step is now PR creation (or push if PR exists). Co-authored-by: Copilot <223556219+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.
Summary
Complete documentation overhaul: restructure by reader journey, add 8 why-first design documents, refresh README.
Changes
Documentation Structure
docs/README.md— New documentation navigation pagedocs/overview.md— Plugin introduction and key concepts (newcomer entry point)docs/getting-started.md+docs/contributing.md— Split fromdevelopment.mddocs/architecture.md— Simplified to high-level layer overview with links to design docsDesign Documents (
docs/design/)8 new why-first documents explaining design intent and rationale:
psi-and-mixin.md— Why mixin pattern for PSI, feature interfacessymbol-resolution.md— Why two-phase resolve, scope hierarchy, root providersstub-indexing.md— Why stubs, index design tradeoffs, external data systemannotation-system.md— Why per-version annotators, validation philosophycode-completion.md— Why provider-per-context, insert handler designcompiler-system.md— Why in-process compiler, plugin architectureprototext.md— Why separate language, schema linking designeditions.md— Why feature-set model, migration from syntax versionsREADME
Workflow Updates
.copilot/files into.github/(brainstorm.md, docmap.md, knowledge.md).intellijPlatformto.gitignore