Skip to content

feat(skills): add docs skill and plugin manifest - #18

Merged
ms-shashank merged 1 commit into
Oxcode-ai:mainfrom
h30s:feat/docs-skill
Aug 31, 2026
Merged

feat(skills): add docs skill and plugin manifest#18
ms-shashank merged 1 commit into
Oxcode-ai:mainfrom
h30s:feat/docs-skill

Conversation

@h30s

@h30s h30s commented Aug 27, 2026

Copy link
Copy Markdown
Member

Resolves #10

Summary

Adds the docs skill and plugin manifest. This skill guides the agent to document code from what it actually does at runtime rather than what it was supposed to do, ground every statement in the code, enforce the skip-the-obvious rule, explicitly name undocumented areas, and report discrepancies between code and documentation as findings rather than resolving them silently.

What task was tested & Before vs. After

  • Task: Documenting a service module with in-memory caching and silent timeout fallbacks that contradicted existing JSDoc comments.
  • Before: Restated function names tautologically (getUser gets a user), assumed standard error throwing based on comments, and silently resolved code-comment mismatches by guessing intent.
  • After: Cited exact file:line references for each guarantee, reported the code-vs-doc drift as a primary finding with risk analysis, highlighted runtime invariants (60s cache, null on 404, fallback behavior), and explicitly stated boundaries on unverified database reconnection paths.

What was deliberately left out

  • No speculative architecture documentation: Kept the scope strictly to what is verified in the source code rather than guessing developer intent or unwritten future roadmap.
  • No auto-editing or code fixes: Uses tools: chat (read-only by default) to keep documentation review focused on analysis and prevent silently editing implementation code.

Checklist

  • Manifest in plugins/docs/.oxcode-plugin/plugin.json declared and valid.
  • Registered in .oxcode-plugin/marketplace.json.
  • Frontmatter uses capability: Deep analysis and tools: chat (no model names).
  • Passes all CI workflow checks.

@h30s
h30s requested a review from ms-shashank August 27, 2026 09:45
@ms-shashank
ms-shashank merged commit 3c20cc2 into Oxcode-ai:main Aug 31, 2026
1 check 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.

New skill: docs, written from the code and honest about the gaps

2 participants