qprisma doc sync

Documentation Community

Skill notes

Required reads

AGENTS.md .github/instructions/docs.instructions.md Changed implementation/workflow files Existing docs that mention the changed behavior CHANGELOG.md when the change is user-visible, operator-visible, release-facing, or workflow-facing

Primary documentation targets

README.md API_DOCUMENTATION.md TESTING.md CHANGELOG.md docs/ARCHITECTURE.md

Guardrails

Prefer edits to existing docs over creating new files. Do not document aspirational behavior; document shipped or explicitly planned workflow only. Do not duplicate large sections. Cross-reference the source of truth. Keep examples runnable and aligned with current repository commands. Explicitly note external prerequisites such as Azure, Neo4j, PostgreSQL, Foundry, or deployed hosted

Process

Identify impacted docs from changed files and user-visible/operator-visible behavior. Search for stale references across docs, Copilot instructions, agents, skills, and PR templates. Update existing sections with precise paths, commands, environment variables, and constraints. Add changelog entries only when the behavior or workflow matters to users, operators, or maintainers. Verify there are no contradictory statements across docs.

Validation

Run git diff --check for text formatting issues. Inspect Markdown headings, links, commands, and examples touched by the change. For docs generated from implementation, run the existing generator/check command if one exists.

Fluxly profile Runtime and permissions are inferred by Fluxly static checks, not author declarations or runtime test results.
Domain
Documentation
Author-declared agents
No explicit declaration found; this is not inferred or tested compatibility
Static check
88 / 100 · heuristic scan, not runtime safety proof
Runtime evidence
Not run; no isolated runtime test evidence is currently recorded
Author / version / license
@tomevault-io · no license declared
Token usage
Lean
Setup complexity
Plug-and-play
External API key
Not required
Operating systems
Unspecified (assume cross-platform)
Runtime requirements
No explicit requirements detected
Detected file/system behavior
  • Read-only
  • Write / modify
  • Env read
Network behavior
Local-only
Install commands
None (reference only)

Heads up: Tool permissions are not declared; actual access depends on the runtime.

Author source file SKILL.md

# QPrisma Documentation Sync Skill

Use this skill when code, APIs, workflows, architecture, evaluation behavior, or maintainer process
changes.

## Required reads

1. `AGENTS.md`
2. `.github/instructions/docs.instructions.md`
3. Changed implementation/workflow files
4. Existing docs that mention the changed behavior
5. `CHANGELOG.md` when the change is user-visible, operator-visible, release-facing, or workflow-facing

## Primary documentation targets

- `README.md`
- `API_DOCUMENTATION.md`
- `TESTING.md`
- `CHANGELOG.md`
- `docs/ARCHITECTURE.md`
- `docs/BACKEND_ARCHITECTURE.md`
- `docs/INFRASTRUCTURE.md`
- `docs/MEMORY_ARCHITECTURE.md`
- `backend/agent/ARCHITECTURE.md`
- `.github/copilot-instructions.md`
- `.github/agents/*.agent.md`
- `.github/skills/*/SKILL.md`
- `.github/PULL_REQUEST_TEMPLATE.md`

## Guardrails

- Prefer edits to existing docs over creating new files.
- Do not document aspirational behavior; document shipped or explicitly planned workflow only.
- Do not duplicate large sections. Cross-reference the source of truth.
- Keep examples runnable and aligned with current repository commands.
- Explicitly note external prerequisites such as Azure, Neo4j, PostgreSQL, Foundry, or deployed hosted
  agent.
- Redact private values in examples and evidence.

## Process

1. Identify impacted docs from changed files and user-visible/operator-visible behavior.
2. Search for stale references across docs, Copilot instructions, agents, skills, and PR templates.
3. Update existing sections with precise paths, commands, environment variables, and constraints.
4. Add changelog entries only when the behavior or workflow matters to users, operators, or maintainers.
5. Verify there are no contradictory statements across docs.

## Validation

- Run `git diff --check` for text formatting issues.
- Inspect Markdown headings, links, commands, and examples touched by the change.
- For docs generated from implementation, run the existing generator/check command if one exists.

## Output format

```markdown
### Updated docs
- `path`: change summary

### Consistency checks
- ...

### Remaining gaps
- ...
```

---
> Source: [alexandergg/QPrisma](https://github.com/alexandergg/QPrisma) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->

Discussion

Powered by GitHub Discussions. Sign in with GitHub to comment, react, or subscribe.