mine-rs-documentation
Use this skill when writing or updating mine-rs documentation, README, roadmap, backlog, AGENTS.md, architecture docs, product scope, Spanish technical docs, conceptual examples, or consistency across
SKILL.md.github/skills/mine-rs-documentation/SKILL.md
GitHubmine-rs documentation skill
Use this skill for documentation, roadmap, README, AGENTS.md, backlog and architecture writing tasks.
Source of truth
For documentation changes, inspect the relevant files:
README.mdAGENTS.mddocs/backlog.mddocs/references/vision.mddocs/references/product-scope.mddocs/references/domain-capabilities.mddocs/references/architecture.mddocs/references/repository-strategy.mddocs/references/python-sdk-design.mddocs/references/agentic-layer.mddocs/references/roadmap.mddocs/references/temporal-backlog.md
Writing conventions
- Write primary project documentation in Spanish.
- Use clear, professional and practical language.
- Distinguish current state, target architecture and future roadmap.
- Mark non-implemented API examples as conceptual.
- Keep
docs/backlog.mdas operational backlog. - Keep
docs/references/repository-strategy.mdas the source of truth for repo/crate/package decisions. - Avoid claiming that planned features already exist.
Documentation procedure
- Determine whether the change is product, architecture, domain, Python SDK, agentic layer or roadmap.
- Update the most specific document first.
- Update README if discoverability changes.
- Update AGENTS.md if future agent behavior should change.
- Keep terminology consistent across docs.
- Check links after edits.
- Keep examples short and label conceptual examples.
Preferred terminology
- "SDK" for the reusable library surface.
- "Rust core" for deterministic compute.
- "Python SDK" or
python/minersfor user-facing Python. - "
mine-tools" for deterministic tool contracts. - "
python/mine-agents" for Python-first agentic orchestration. - "Capa agentica" for agents, VFS, task tools, subagents and verifiers.
Gotchas
- Do not turn the project into a GUI-first product in docs.
- Do not blur SDK responsibilities with agent responsibilities.
- Do not duplicate roadmap details if the backlog already owns ticket-level execution.
- Do not remove the monorepo decision unless explicitly asked to reevaluate it.