Skip to content

docs: add plugins page to nav, apply standards, trim design doc#663

Merged
planetf1 merged 1 commit intogenerative-computing:mainfrom
planetf1:docs/plugins-nav-and-standards
Mar 17, 2026
Merged

docs: add plugins page to nav, apply standards, trim design doc#663
planetf1 merged 1 commit intogenerative-computing:mainfrom
planetf1:docs/plugins-nav-and-standards

Conversation

@planetf1
Copy link
Contributor

@planetf1 planetf1 commented Mar 17, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue:

Fixes #649

Add the plugins & hooks page to the docs site navigation and bring it up to documentation standards.

Changes:

  • Move plugins.mdx from core-concept/ to concepts/ (all other core-concept/ pages were already migrated)
  • Add to Concepts nav group in docs.json
  • Apply doc standards: # diataxis: frontmatter, sentence-case headings, markdownlint fixes, See also footer
  • Add glossary links on first use of Component, Requirement, MelleaSession
  • Add glossary entries for Hook/HookType, Plugin, PluginSet
  • Fix broken internal link (/core-concept/interoperability/integrations/mcp)
  • Trim docs/dev/hook_system.md to internal design notes only, with pointer to user-facing page

Note: Page is 975 lines (above the 800-line split guidance). Worth a follow-up to split but not blocking.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

- Move plugins.mdx from core-concept/ to concepts/ (matches existing
  convention; all other core-concept/ pages already migrated)
- Add to Concepts group in docs.json navigation
- Apply documentation standards: diataxis frontmatter, sentence-case
  headings, markdownlint fixes, See also footer, glossary links on
  first use of Component/Requirement/MelleaSession
- Fix broken internal link (/core-concept/interoperability → /integrations/mcp)
- Add glossary entries: Hook/HookType, Plugin, PluginSet
- Trim docs/dev/hook_system.md to internal design notes only, with
  pointer to user-facing page for usage docs
@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify
Copy link

mergify bot commented Mar 17, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@planetf1 planetf1 marked this pull request as ready for review March 17, 2026 10:41
@planetf1 planetf1 requested a review from a team as a code owner March 17, 2026 10:41
@planetf1
Copy link
Contributor Author

@araujof I've linked in the docs to the main hierarchy & removed user-facing content from the dev docs (these are not in the external docs) to keep that as an implementation reference. I can remove those changes if you prefer.
Only minimal changes otherwise

@ajbozarth may have some additional improvements based on his usage - anything small we can clarify here, but if any significant changes it's something we could do as a later pr -- here we get the current docs linked in.

@planetf1 planetf1 added this pull request to the merge queue Mar 17, 2026
Merged via the queue into generative-computing:main with commit 3c0cfa4 Mar 17, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Create user-facing documentation for hooks/plugins feature

2 participants