Creator · TidyFactor
Last updated · Aug 27, 2026
TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline
Creator · TidyFactor
Last updated · Aug 27, 2026
TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline
Creator · TidyFactor
Last updated · Aug 27, 2026
TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline
Creator · TidyFactor
Last updated · Aug 27, 2026
TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline
Do not auto-install
Install targets
Codex install prompt
Install the "tidyfactor-doc" agent skill from https://github.com/TidyFactor/Doc/blob/main/SKILL.md. Read its SKILL.md or equivalent instructions first, install only the files needed for this workspace, and summarize any required setup before using it. Skill purpose: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. After the install attempt, report the result to https://www.openagentskill.com/api/agent/outcome with POST JSON {"event_id":"install_<unique-id>","skill_slug":"tidyfactor-doc","task":"Install tidyfactor-doc","agent":"codex","outcome":"success","install_used":true}. Replace event_id with a unique value and outcome with success or failed. Report success only after the skill is installed and a minimal verification passes.Supply asset profile
Code review, repo analysis, testing, CI, GitHub, DevOps, and developer workflow skills.
Scenario
Coding agents
I need a coding agent that can understand a repository, edit code, and review pull requests.
Agent fit
Claude Code + CLI + Codex
Codex, Claude Code, Cursor, CLI, or custom agents.
Install
Ready
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Maintenance
fresh
5d since push
Risk
Needs review
Permission surface may require sandboxing
GitHub quality
1
56/100 Quality · 63/100 Trust
Coverage tags
Review notes
Permission surface may require sandboxing · Repository license detected as NOASSERTION; brand.json declares Apache-2.0 but no LICENSE file is present in the repository.
Agent adoption scorecard
These scores combine public repository metadata, OpenAgentSkill review signals, maintenance freshness, and install readiness. They are a shortlist signal, not a replacement for human review.
Quality
PromisingUseful candidate, but compare it with alternatives before adopting.
Trust
Do not auto-installTrust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
Audit
Needs reviewA machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
OpenAgentSkill Trust Score v5
Choose a stronger alternative or inspect the source manually before any install attempt.
Stars
1 GitHub stars
Repo activity
1 stars, 0 forks
Maintenance
5d since push
License
NOASSERTION
Install
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Install safety
Agent-readable metadata
Use this block or the embedded JSON to decide whether an agent should install this skill, choose an alternative, or ask for human review first.
Suited tasks
Suited agents
Install decision
Trust and risk
Outcome loop
Install command
npx skills add TidyFactor/Doc --skill tidyfactor-docDo not use when
Alternative
40.4K Stars
npx skills add PatrickJS/awesome-cursorrules
Alternative
637 Stars
npx skills add sandbaseai/sandbase-harness --skill code-review
Alternative
11 Stars
npx skills add Bilalkhan4086/Skills-Learning
Alternative
4 Stars
npx skills add szarkans/multi --skill code-review
Agent safety v2
This skill should not be selected by an agent without explicit human security review.
Do not auto-install. Inspect the source, dependencies, and permission surface first.
high
Skill metadata references terminal, CLI, shell, subprocess, or command execution workflows.
medium
Skill likely fetches remote pages, APIs, repositories, or external services.
medium
Skill may read or write project files, documents, generated artifacts, or local workspace state.
high
Skill metadata references credentials, tokens, environment variables, or secret-bearing workflows.
Agent resolve plan
The Resolve API returns the selected skill, alternatives, safety policy, audit notes, install target, and copy-paste prompt an agent can follow without scraping this page.
Open JSON
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Resolve text
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium&format=text
Install handoff
/api/skills/tidyfactor-doc/install
Agent should check
Copy prompt
Task: Use tidyfactor-doc in this workspace.
Resolve first: https://www.openagentskill.com/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Review install handoff: https://www.openagentskill.com/api/skills/tidyfactor-doc/install
Install command: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Before running it, summarize audit warnings, required permissions, and the fallback skill if install is risky.Agent handoff
Use the public install endpoint to fetch the command, safety checklist, target prompts, and canonical links for this skill.
Install handoff
/api/skills/tidyfactor-doc/install
LLM text format
/api/skills/tidyfactor-doc/install?format=text
Find alternatives
/api/skills/search?q=tidyfactor-doc&limit=3
Agent prompt
Use tidyfactor-doc for this task. Review https://www.openagentskill.com/api/skills/tidyfactor-doc/install, then install with: npx skills add TidyFactor/Doc --skill tidyfactor-docRegistry metadata
This page exposes the same decision, trust, audit, use-case, and install signals through the Registry API, so agents can rank this skill without scraping the UI.
Manifest
/api/registry/manifest/tidyfactor-doc
LLM text
/api/registry/manifest/tidyfactor-doc?format=text
Install alias
/api/registry/install/tidyfactor-doc
Recommend
/api/registry/recommend?task=Use%20tidyfactor-doc%20in%20an%20agent%20workflow&limit=3
Agent fit
Local desktop
Use-case tags
Platforms
Claude Code
Audit report
A machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
Agent decision cockpit
Do a manual repository review before adding this to an agent workflow.
Role in stack
Needs validation
Primary fit
Local desktop
Trust label
Needs manual review
Install path
Command ready
Use when
Evidence
review first
Implementation path
Trust profile
Trust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
GitHub adoption
FIX1 GitHub stars
Stars/forks activity
FIX1 stars, 0 forks; issue activity unavailable in current metadata
Recent maintenance
PASS5d since push
License clarity
PASSNOASSERTION
Good signals
Review before install
Recommended action
Choose a stronger alternative or inspect the source manually before any install attempt.
Quality profile
Useful candidate, but compare it with alternatives before adopting.
Workflow fit
Operate local tools
I need my agent to operate local files and desktop apps in a repeatable workflow.
Parse messy files
I need my agent to read PDFs, extract tables, and turn documents into structured data.
Publish consistently
I need my agent to turn research and product updates into useful content drafts.
Workflow fit
Turn skills into distribution
A workflow for turning newly indexed skills into SEO briefs, social drafts, comparison pages, and reusable publishing workflows.
Inspect, patch, and verify code
A workflow for software agents that inspect repositories, review pull requests, generate tests, and turn findings into shippable patches.
Operate and verify web apps
A workflow for agents that navigate products, fill forms, take screenshots, and verify real user flows across web applications.
Alternative shortlist
Similar skills that may fit this task.
A curated collection of cursor rules for various frameworks and technologies
Reviews a supplied code path or diff for correctness, security, maintainability, and style without executing or modifying it
>-
--- name: tidyfactor-doc description: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. ---
# TidyFactor Doc
A command dispatcher. This file does not do the work itself — it routes to the right command, which routes to the right workflow, which injects the right memory.
## Commands
| User intent | Command | What it loads | |---|---|---| | "Set up docs for this project" / "scaffold /docs" | `references/commands/init.md` | `workflows/init-docs.md` + `memory/doc-tree.md` | | "Document this codebase" / "gather what's needed to document X" | `references/commands/collect.md` | `workflows/collect.md` + `memory/collection-sources.md` | | "Write API docs" / "generate a README" / "add inline comments" / "write a guide" | `references/commands/generate.md` | `workflows/generate-api.md` (or `generate-readme.md` / `generate-inline.md` / `generate-guide.md`) + `memory/doc-templates.md` + matching `memory/stacks/*.md` | | "Publish documentation portal" / "turn /docs into a doc site" (Interactive) | `references/commands/site.md` | `memory/site-engines.md` + interactive selection (`workflows/mkdocs.md` or `workflows/docsify.md`) | | "Set up MkDocs Material" / "compile static documentation" | `references/commands/mkdocs.md` | `workflows/mkdocs.md` + `memory/mkdocs-config.md` | | "Set up Docsify" / "build lightweight zero-build doc SPA" | `references/commands/docsify.md` | `workflows/docsify.md` + `memory/docsify-config.md` |
Read only the command file that matches the request. Do not read all commands simultaneously.
## Non-negotiable constraints on every command
1. **All generated documentation lives under `/docs`.** Never write API references, guides, or generated READMEs to another location. (`README.md` itself stays at the project root, per convention — everything else generated goes in `/docs`.) 2. **`generate` never invents content.** It only writes docs from what `collect` gathered (or equivalent detail the user supplies directly in the conversation) — never from assumed signatures, assumed env vars, or assumed behavior. If required detail is missing, `generate` says what's missing and asks or falls back to running `collect` first. 3. **Stack rules are looked up, never guessed.** Before writing any code-level doc (API reference, inline comments), load the matching file under `memory/stacks/` for the language/framework actually in use. Do not mix PHPDoc conventions into a TypeScript file or vice versa. 4. **`site`, `mkdocs`, and `docsify` only organize and publish what's already in `/docs`.** They never author new documentation content — that's `generate`'s job. - For **MkDocs Material**: Generate standard `mkdocs.yml`, configure Neo-Brutalist CSS tokens (`extra.css`), configure Arabic/English i18n (`*.ar.md` suffix), and build cleanly with `mkdocs build --strict`. - For **Docsify**: Include `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` and root-relative leading slashes `/` in `_sidebar.md` to guarantee persistent sidebar navigation across all subfolder routes. 5. **Standalone.** This skill does not read or depend on any other `tidyfactor-*` skill's conventions, even when the project happens to be built on one of those tracks. 6. **Zero Sensitive Data Leakage.** Under absolutely no circumstances should any real sensitive data (e.g., real API tokens, WHM/cPanel passwords, production server IPs, real DB credentials, secret keys, private auth tokens, or local absolute drive paths) be written into documentation. ALWAYS redact and replace these with safe generic placeholders. 7. **Clean Relative Links Only.** Never include local machine filesystem URLs (such as `file:///C:/...`, `file:c:`, or absolute workstation paths) in documentation links or markdown cross-references. All document cross-links must use clean relative markdown paths or standard public web URLs (`https://...`).
## Sequencing
`init` → `collect` → `generate` (repeatable, once per doc target) → `site` / `mkdocs` / `docsify` (optional, once /docs has real content).
Decision snapshot
recent repository activity
Audit
Install and adoption review
Agent-proven evidence
Outcome reports after resolve, review, install, and one narrow run.
No agent outcome data yet. The first agent run can report success, setup needs, risk blocks, failure, or not-relevant through /api/agent/outcome.
Install
Free and open source. Review the report before installing into production agents.
Growth loop
Scenario-led draft for tidyfactor-doc, ready for a manual X post.
A practical pick for a web workflow: tidyfactor-doc: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews cod... 1 stars https://www.openagentskill.com/skills/tidyfactor-doc?ref=x
Listing + install path for tidyfactor-doc: https://www.openagentskill.com/skills/tidyfactor-doc?ref=x Install: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Listing source
This listing was indexed from public sources and is not marked official until a maintainer claim is approved.
Attribution links to the public repository or creator profile. Creators can claim the listing to update ownership signals.
Claim this skillOwner claim
This Community submitted listing is attributed to TidyFactor but is not marked official yet. Claim it to add a verified owner signal and make future launch, install, and audit updates easier to trust.
Creator backlink kit
Show the canonical listing, current trust and audit signals, and real Agent-Proven evidence where developers evaluate the repository.
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc/audit)
[](https://www.openagentskill.com/skills/tidyfactor-doc)Share whether this skill looks useful for your agent workflow. Aggregated feedback improves rankings over time.
Do not auto-install
Do not auto-install
Install targets
Codex install prompt
Install the "tidyfactor-doc" agent skill from https://github.com/TidyFactor/Doc/blob/main/SKILL.md. Read its SKILL.md or equivalent instructions first, install only the files needed for this workspace, and summarize any required setup before using it. Skill purpose: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. After the install attempt, report the result to https://www.openagentskill.com/api/agent/outcome with POST JSON {"event_id":"install_<unique-id>","skill_slug":"tidyfactor-doc","task":"Install tidyfactor-doc","agent":"codex","outcome":"success","install_used":true}. Replace event_id with a unique value and outcome with success or failed. Report success only after the skill is installed and a minimal verification passes.Supply asset profile
Code review, repo analysis, testing, CI, GitHub, DevOps, and developer workflow skills.
Scenario
Coding agents
I need a coding agent that can understand a repository, edit code, and review pull requests.
Agent fit
Claude Code + CLI + Codex
Codex, Claude Code, Cursor, CLI, or custom agents.
Install
Ready
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Maintenance
fresh
5d since push
Risk
Needs review
Permission surface may require sandboxing
GitHub quality
1
56/100 Quality · 63/100 Trust
Coverage tags
Review notes
Permission surface may require sandboxing · Repository license detected as NOASSERTION; brand.json declares Apache-2.0 but no LICENSE file is present in the repository.
Agent adoption scorecard
These scores combine public repository metadata, OpenAgentSkill review signals, maintenance freshness, and install readiness. They are a shortlist signal, not a replacement for human review.
Quality
PromisingUseful candidate, but compare it with alternatives before adopting.
Trust
Do not auto-installTrust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
Audit
Needs reviewA machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
OpenAgentSkill Trust Score v5
Choose a stronger alternative or inspect the source manually before any install attempt.
Stars
1 GitHub stars
Repo activity
1 stars, 0 forks
Maintenance
5d since push
License
NOASSERTION
Install
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Install safety
Agent-readable metadata
Use this block or the embedded JSON to decide whether an agent should install this skill, choose an alternative, or ask for human review first.
Suited tasks
Suited agents
Install decision
Trust and risk
Outcome loop
Install command
npx skills add TidyFactor/Doc --skill tidyfactor-docDo not use when
Alternative
40.4K Stars
npx skills add PatrickJS/awesome-cursorrules
Alternative
637 Stars
npx skills add sandbaseai/sandbase-harness --skill code-review
Alternative
11 Stars
npx skills add Bilalkhan4086/Skills-Learning
Alternative
4 Stars
npx skills add szarkans/multi --skill code-review
Agent safety v2
This skill should not be selected by an agent without explicit human security review.
Do not auto-install. Inspect the source, dependencies, and permission surface first.
high
Skill metadata references terminal, CLI, shell, subprocess, or command execution workflows.
medium
Skill likely fetches remote pages, APIs, repositories, or external services.
medium
Skill may read or write project files, documents, generated artifacts, or local workspace state.
high
Skill metadata references credentials, tokens, environment variables, or secret-bearing workflows.
Agent resolve plan
The Resolve API returns the selected skill, alternatives, safety policy, audit notes, install target, and copy-paste prompt an agent can follow without scraping this page.
Open JSON
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Resolve text
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium&format=text
Install handoff
/api/skills/tidyfactor-doc/install
Agent should check
Copy prompt
Task: Use tidyfactor-doc in this workspace.
Resolve first: https://www.openagentskill.com/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Review install handoff: https://www.openagentskill.com/api/skills/tidyfactor-doc/install
Install command: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Before running it, summarize audit warnings, required permissions, and the fallback skill if install is risky.Agent handoff
Use the public install endpoint to fetch the command, safety checklist, target prompts, and canonical links for this skill.
Install handoff
/api/skills/tidyfactor-doc/install
LLM text format
/api/skills/tidyfactor-doc/install?format=text
Find alternatives
/api/skills/search?q=tidyfactor-doc&limit=3
Agent prompt
Use tidyfactor-doc for this task. Review https://www.openagentskill.com/api/skills/tidyfactor-doc/install, then install with: npx skills add TidyFactor/Doc --skill tidyfactor-docRegistry metadata
This page exposes the same decision, trust, audit, use-case, and install signals through the Registry API, so agents can rank this skill without scraping the UI.
Manifest
/api/registry/manifest/tidyfactor-doc
LLM text
/api/registry/manifest/tidyfactor-doc?format=text
Install alias
/api/registry/install/tidyfactor-doc
Recommend
/api/registry/recommend?task=Use%20tidyfactor-doc%20in%20an%20agent%20workflow&limit=3
Agent fit
Local desktop
Use-case tags
Platforms
Claude Code
Audit report
A machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
Agent decision cockpit
Do a manual repository review before adding this to an agent workflow.
Role in stack
Needs validation
Primary fit
Local desktop
Trust label
Needs manual review
Install path
Command ready
Use when
Evidence
review first
Implementation path
Trust profile
Trust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
GitHub adoption
FIX1 GitHub stars
Stars/forks activity
FIX1 stars, 0 forks; issue activity unavailable in current metadata
Recent maintenance
PASS5d since push
License clarity
PASSNOASSERTION
Good signals
Review before install
Recommended action
Choose a stronger alternative or inspect the source manually before any install attempt.
Quality profile
Useful candidate, but compare it with alternatives before adopting.
Workflow fit
Operate local tools
I need my agent to operate local files and desktop apps in a repeatable workflow.
Parse messy files
I need my agent to read PDFs, extract tables, and turn documents into structured data.
Publish consistently
I need my agent to turn research and product updates into useful content drafts.
Workflow fit
Turn skills into distribution
A workflow for turning newly indexed skills into SEO briefs, social drafts, comparison pages, and reusable publishing workflows.
Inspect, patch, and verify code
A workflow for software agents that inspect repositories, review pull requests, generate tests, and turn findings into shippable patches.
Operate and verify web apps
A workflow for agents that navigate products, fill forms, take screenshots, and verify real user flows across web applications.
Alternative shortlist
Similar skills that may fit this task.
A curated collection of cursor rules for various frameworks and technologies
Reviews a supplied code path or diff for correctness, security, maintainability, and style without executing or modifying it
>-
--- name: tidyfactor-doc description: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. ---
# TidyFactor Doc
A command dispatcher. This file does not do the work itself — it routes to the right command, which routes to the right workflow, which injects the right memory.
## Commands
| User intent | Command | What it loads | |---|---|---| | "Set up docs for this project" / "scaffold /docs" | `references/commands/init.md` | `workflows/init-docs.md` + `memory/doc-tree.md` | | "Document this codebase" / "gather what's needed to document X" | `references/commands/collect.md` | `workflows/collect.md` + `memory/collection-sources.md` | | "Write API docs" / "generate a README" / "add inline comments" / "write a guide" | `references/commands/generate.md` | `workflows/generate-api.md` (or `generate-readme.md` / `generate-inline.md` / `generate-guide.md`) + `memory/doc-templates.md` + matching `memory/stacks/*.md` | | "Publish documentation portal" / "turn /docs into a doc site" (Interactive) | `references/commands/site.md` | `memory/site-engines.md` + interactive selection (`workflows/mkdocs.md` or `workflows/docsify.md`) | | "Set up MkDocs Material" / "compile static documentation" | `references/commands/mkdocs.md` | `workflows/mkdocs.md` + `memory/mkdocs-config.md` | | "Set up Docsify" / "build lightweight zero-build doc SPA" | `references/commands/docsify.md` | `workflows/docsify.md` + `memory/docsify-config.md` |
Read only the command file that matches the request. Do not read all commands simultaneously.
## Non-negotiable constraints on every command
1. **All generated documentation lives under `/docs`.** Never write API references, guides, or generated READMEs to another location. (`README.md` itself stays at the project root, per convention — everything else generated goes in `/docs`.) 2. **`generate` never invents content.** It only writes docs from what `collect` gathered (or equivalent detail the user supplies directly in the conversation) — never from assumed signatures, assumed env vars, or assumed behavior. If required detail is missing, `generate` says what's missing and asks or falls back to running `collect` first. 3. **Stack rules are looked up, never guessed.** Before writing any code-level doc (API reference, inline comments), load the matching file under `memory/stacks/` for the language/framework actually in use. Do not mix PHPDoc conventions into a TypeScript file or vice versa. 4. **`site`, `mkdocs`, and `docsify` only organize and publish what's already in `/docs`.** They never author new documentation content — that's `generate`'s job. - For **MkDocs Material**: Generate standard `mkdocs.yml`, configure Neo-Brutalist CSS tokens (`extra.css`), configure Arabic/English i18n (`*.ar.md` suffix), and build cleanly with `mkdocs build --strict`. - For **Docsify**: Include `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` and root-relative leading slashes `/` in `_sidebar.md` to guarantee persistent sidebar navigation across all subfolder routes. 5. **Standalone.** This skill does not read or depend on any other `tidyfactor-*` skill's conventions, even when the project happens to be built on one of those tracks. 6. **Zero Sensitive Data Leakage.** Under absolutely no circumstances should any real sensitive data (e.g., real API tokens, WHM/cPanel passwords, production server IPs, real DB credentials, secret keys, private auth tokens, or local absolute drive paths) be written into documentation. ALWAYS redact and replace these with safe generic placeholders. 7. **Clean Relative Links Only.** Never include local machine filesystem URLs (such as `file:///C:/...`, `file:c:`, or absolute workstation paths) in documentation links or markdown cross-references. All document cross-links must use clean relative markdown paths or standard public web URLs (`https://...`).
## Sequencing
`init` → `collect` → `generate` (repeatable, once per doc target) → `site` / `mkdocs` / `docsify` (optional, once /docs has real content).
Decision snapshot
recent repository activity
Audit
Install and adoption review
Agent-proven evidence
Outcome reports after resolve, review, install, and one narrow run.
No agent outcome data yet. The first agent run can report success, setup needs, risk blocks, failure, or not-relevant through /api/agent/outcome.
Install
Free and open source. Review the report before installing into production agents.
Growth loop
Scenario-led draft for tidyfactor-doc, ready for a manual X post.
A practical pick for a web workflow: tidyfactor-doc: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews cod... 1 stars https://www.openagentskill.com/skills/tidyfactor-doc?ref=x
Listing + install path for tidyfactor-doc: https://www.openagentskill.com/skills/tidyfactor-doc?ref=x Install: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Listing source
This listing was indexed from public sources and is not marked official until a maintainer claim is approved.
Attribution links to the public repository or creator profile. Creators can claim the listing to update ownership signals.
Claim this skillOwner claim
This Community submitted listing is attributed to TidyFactor but is not marked official yet. Claim it to add a verified owner signal and make future launch, install, and audit updates easier to trust.
Creator backlink kit
Show the canonical listing, current trust and audit signals, and real Agent-Proven evidence where developers evaluate the repository.
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc/audit)
[](https://www.openagentskill.com/skills/tidyfactor-doc)Share whether this skill looks useful for your agent workflow. Aggregated feedback improves rankings over time.
Do not auto-install
Do not auto-install
Install targets
Codex install prompt
Install the "tidyfactor-doc" agent skill from https://github.com/TidyFactor/Doc/blob/main/SKILL.md. Read its SKILL.md or equivalent instructions first, install only the files needed for this workspace, and summarize any required setup before using it. Skill purpose: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. After the install attempt, report the result to https://www.openagentskill.com/api/agent/outcome with POST JSON {"event_id":"install_<unique-id>","skill_slug":"tidyfactor-doc","task":"Install tidyfactor-doc","agent":"codex","outcome":"success","install_used":true}. Replace event_id with a unique value and outcome with success or failed. Report success only after the skill is installed and a minimal verification passes.Supply asset profile
Code review, repo analysis, testing, CI, GitHub, DevOps, and developer workflow skills.
Scenario
Coding agents
I need a coding agent that can understand a repository, edit code, and review pull requests.
Agent fit
Claude Code + CLI + Codex
Codex, Claude Code, Cursor, CLI, or custom agents.
Install
Ready
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Maintenance
fresh
5d since push
Risk
Needs review
Permission surface may require sandboxing
GitHub quality
1
56/100 Quality · 63/100 Trust
Coverage tags
Review notes
Permission surface may require sandboxing · Repository license detected as NOASSERTION; brand.json declares Apache-2.0 but no LICENSE file is present in the repository.
Agent adoption scorecard
These scores combine public repository metadata, OpenAgentSkill review signals, maintenance freshness, and install readiness. They are a shortlist signal, not a replacement for human review.
Quality
PromisingUseful candidate, but compare it with alternatives before adopting.
Trust
Do not auto-installTrust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
Audit
Needs reviewA machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
OpenAgentSkill Trust Score v5
Choose a stronger alternative or inspect the source manually before any install attempt.
Stars
1 GitHub stars
Repo activity
1 stars, 0 forks
Maintenance
5d since push
License
NOASSERTION
Install
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Install safety
Agent-readable metadata
Use this block or the embedded JSON to decide whether an agent should install this skill, choose an alternative, or ask for human review first.
Suited tasks
Suited agents
Install decision
Trust and risk
Outcome loop
Install command
npx skills add TidyFactor/Doc --skill tidyfactor-docDo not use when
Alternative
40.4K Stars
npx skills add PatrickJS/awesome-cursorrules
Alternative
637 Stars
npx skills add sandbaseai/sandbase-harness --skill code-review
Alternative
11 Stars
npx skills add Bilalkhan4086/Skills-Learning
Alternative
4 Stars
npx skills add szarkans/multi --skill code-review
Agent safety v2
This skill should not be selected by an agent without explicit human security review.
Do not auto-install. Inspect the source, dependencies, and permission surface first.
high
Skill metadata references terminal, CLI, shell, subprocess, or command execution workflows.
medium
Skill likely fetches remote pages, APIs, repositories, or external services.
medium
Skill may read or write project files, documents, generated artifacts, or local workspace state.
high
Skill metadata references credentials, tokens, environment variables, or secret-bearing workflows.
Agent resolve plan
The Resolve API returns the selected skill, alternatives, safety policy, audit notes, install target, and copy-paste prompt an agent can follow without scraping this page.
Open JSON
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Resolve text
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium&format=text
Install handoff
/api/skills/tidyfactor-doc/install
Agent should check
Copy prompt
Task: Use tidyfactor-doc in this workspace.
Resolve first: https://www.openagentskill.com/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Review install handoff: https://www.openagentskill.com/api/skills/tidyfactor-doc/install
Install command: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Before running it, summarize audit warnings, required permissions, and the fallback skill if install is risky.Agent handoff
Use the public install endpoint to fetch the command, safety checklist, target prompts, and canonical links for this skill.
Install handoff
/api/skills/tidyfactor-doc/install
LLM text format
/api/skills/tidyfactor-doc/install?format=text
Find alternatives
/api/skills/search?q=tidyfactor-doc&limit=3
Agent prompt
Use tidyfactor-doc for this task. Review https://www.openagentskill.com/api/skills/tidyfactor-doc/install, then install with: npx skills add TidyFactor/Doc --skill tidyfactor-docRegistry metadata
This page exposes the same decision, trust, audit, use-case, and install signals through the Registry API, so agents can rank this skill without scraping the UI.
Manifest
/api/registry/manifest/tidyfactor-doc
LLM text
/api/registry/manifest/tidyfactor-doc?format=text
Install alias
/api/registry/install/tidyfactor-doc
Recommend
/api/registry/recommend?task=Use%20tidyfactor-doc%20in%20an%20agent%20workflow&limit=3
Agent fit
Local desktop
Use-case tags
Platforms
Claude Code
Audit report
A machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
Agent decision cockpit
Do a manual repository review before adding this to an agent workflow.
Role in stack
Needs validation
Primary fit
Local desktop
Trust label
Needs manual review
Install path
Command ready
Use when
Evidence
review first
Implementation path
Trust profile
Trust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
GitHub adoption
FIX1 GitHub stars
Stars/forks activity
FIX1 stars, 0 forks; issue activity unavailable in current metadata
Recent maintenance
PASS5d since push
License clarity
PASSNOASSERTION
Good signals
Review before install
Recommended action
Choose a stronger alternative or inspect the source manually before any install attempt.
Quality profile
Useful candidate, but compare it with alternatives before adopting.
Workflow fit
Operate local tools
I need my agent to operate local files and desktop apps in a repeatable workflow.
Parse messy files
I need my agent to read PDFs, extract tables, and turn documents into structured data.
Publish consistently
I need my agent to turn research and product updates into useful content drafts.
Workflow fit
Turn skills into distribution
A workflow for turning newly indexed skills into SEO briefs, social drafts, comparison pages, and reusable publishing workflows.
Inspect, patch, and verify code
A workflow for software agents that inspect repositories, review pull requests, generate tests, and turn findings into shippable patches.
Operate and verify web apps
A workflow for agents that navigate products, fill forms, take screenshots, and verify real user flows across web applications.
Alternative shortlist
Similar skills that may fit this task.
A curated collection of cursor rules for various frameworks and technologies
Reviews a supplied code path or diff for correctness, security, maintainability, and style without executing or modifying it
>-
--- name: tidyfactor-doc description: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. ---
# TidyFactor Doc
A command dispatcher. This file does not do the work itself — it routes to the right command, which routes to the right workflow, which injects the right memory.
## Commands
| User intent | Command | What it loads | |---|---|---| | "Set up docs for this project" / "scaffold /docs" | `references/commands/init.md` | `workflows/init-docs.md` + `memory/doc-tree.md` | | "Document this codebase" / "gather what's needed to document X" | `references/commands/collect.md` | `workflows/collect.md` + `memory/collection-sources.md` | | "Write API docs" / "generate a README" / "add inline comments" / "write a guide" | `references/commands/generate.md` | `workflows/generate-api.md` (or `generate-readme.md` / `generate-inline.md` / `generate-guide.md`) + `memory/doc-templates.md` + matching `memory/stacks/*.md` | | "Publish documentation portal" / "turn /docs into a doc site" (Interactive) | `references/commands/site.md` | `memory/site-engines.md` + interactive selection (`workflows/mkdocs.md` or `workflows/docsify.md`) | | "Set up MkDocs Material" / "compile static documentation" | `references/commands/mkdocs.md` | `workflows/mkdocs.md` + `memory/mkdocs-config.md` | | "Set up Docsify" / "build lightweight zero-build doc SPA" | `references/commands/docsify.md` | `workflows/docsify.md` + `memory/docsify-config.md` |
Read only the command file that matches the request. Do not read all commands simultaneously.
## Non-negotiable constraints on every command
1. **All generated documentation lives under `/docs`.** Never write API references, guides, or generated READMEs to another location. (`README.md` itself stays at the project root, per convention — everything else generated goes in `/docs`.) 2. **`generate` never invents content.** It only writes docs from what `collect` gathered (or equivalent detail the user supplies directly in the conversation) — never from assumed signatures, assumed env vars, or assumed behavior. If required detail is missing, `generate` says what's missing and asks or falls back to running `collect` first. 3. **Stack rules are looked up, never guessed.** Before writing any code-level doc (API reference, inline comments), load the matching file under `memory/stacks/` for the language/framework actually in use. Do not mix PHPDoc conventions into a TypeScript file or vice versa. 4. **`site`, `mkdocs`, and `docsify` only organize and publish what's already in `/docs`.** They never author new documentation content — that's `generate`'s job. - For **MkDocs Material**: Generate standard `mkdocs.yml`, configure Neo-Brutalist CSS tokens (`extra.css`), configure Arabic/English i18n (`*.ar.md` suffix), and build cleanly with `mkdocs build --strict`. - For **Docsify**: Include `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` and root-relative leading slashes `/` in `_sidebar.md` to guarantee persistent sidebar navigation across all subfolder routes. 5. **Standalone.** This skill does not read or depend on any other `tidyfactor-*` skill's conventions, even when the project happens to be built on one of those tracks. 6. **Zero Sensitive Data Leakage.** Under absolutely no circumstances should any real sensitive data (e.g., real API tokens, WHM/cPanel passwords, production server IPs, real DB credentials, secret keys, private auth tokens, or local absolute drive paths) be written into documentation. ALWAYS redact and replace these with safe generic placeholders. 7. **Clean Relative Links Only.** Never include local machine filesystem URLs (such as `file:///C:/...`, `file:c:`, or absolute workstation paths) in documentation links or markdown cross-references. All document cross-links must use clean relative markdown paths or standard public web URLs (`https://...`).
## Sequencing
`init` → `collect` → `generate` (repeatable, once per doc target) → `site` / `mkdocs` / `docsify` (optional, once /docs has real content).
Decision snapshot
recent repository activity
Audit
Install and adoption review
Agent-proven evidence
Outcome reports after resolve, review, install, and one narrow run.
No agent outcome data yet. The first agent run can report success, setup needs, risk blocks, failure, or not-relevant through /api/agent/outcome.
Install
Free and open source. Review the report before installing into production agents.
Growth loop
Scenario-led draft for tidyfactor-doc, ready for a manual X post.
A practical pick for a web workflow: tidyfactor-doc: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews cod... 1 stars https://www.openagentskill.com/skills/tidyfactor-doc?ref=x
Listing + install path for tidyfactor-doc: https://www.openagentskill.com/skills/tidyfactor-doc?ref=x Install: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Listing source
This listing was indexed from public sources and is not marked official until a maintainer claim is approved.
Attribution links to the public repository or creator profile. Creators can claim the listing to update ownership signals.
Claim this skillOwner claim
This Community submitted listing is attributed to TidyFactor but is not marked official yet. Claim it to add a verified owner signal and make future launch, install, and audit updates easier to trust.
Creator backlink kit
Show the canonical listing, current trust and audit signals, and real Agent-Proven evidence where developers evaluate the repository.
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc/audit)
[](https://www.openagentskill.com/skills/tidyfactor-doc)Share whether this skill looks useful for your agent workflow. Aggregated feedback improves rankings over time.
Do not auto-install
Do not auto-install
Install targets
Codex install prompt
Install the "tidyfactor-doc" agent skill from https://github.com/TidyFactor/Doc/blob/main/SKILL.md. Read its SKILL.md or equivalent instructions first, install only the files needed for this workspace, and summarize any required setup before using it. Skill purpose: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. After the install attempt, report the result to https://www.openagentskill.com/api/agent/outcome with POST JSON {"event_id":"install_<unique-id>","skill_slug":"tidyfactor-doc","task":"Install tidyfactor-doc","agent":"codex","outcome":"success","install_used":true}. Replace event_id with a unique value and outcome with success or failed. Report success only after the skill is installed and a minimal verification passes.Supply asset profile
Code review, repo analysis, testing, CI, GitHub, DevOps, and developer workflow skills.
Scenario
Coding agents
I need a coding agent that can understand a repository, edit code, and review pull requests.
Agent fit
Claude Code + CLI + Codex
Codex, Claude Code, Cursor, CLI, or custom agents.
Install
Ready
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Maintenance
fresh
5d since push
Risk
Needs review
Permission surface may require sandboxing
GitHub quality
1
56/100 Quality · 63/100 Trust
Coverage tags
Review notes
Permission surface may require sandboxing · Repository license detected as NOASSERTION; brand.json declares Apache-2.0 but no LICENSE file is present in the repository.
Agent adoption scorecard
These scores combine public repository metadata, OpenAgentSkill review signals, maintenance freshness, and install readiness. They are a shortlist signal, not a replacement for human review.
Quality
PromisingUseful candidate, but compare it with alternatives before adopting.
Trust
Do not auto-installTrust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
Audit
Needs reviewA machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
OpenAgentSkill Trust Score v5
Choose a stronger alternative or inspect the source manually before any install attempt.
Stars
1 GitHub stars
Repo activity
1 stars, 0 forks
Maintenance
5d since push
License
NOASSERTION
Install
npx skills add TidyFactor/Doc --skill tidyfactor-doc
Install safety
Agent-readable metadata
Use this block or the embedded JSON to decide whether an agent should install this skill, choose an alternative, or ask for human review first.
Suited tasks
Suited agents
Install decision
Trust and risk
Outcome loop
Install command
npx skills add TidyFactor/Doc --skill tidyfactor-docDo not use when
Alternative
40.4K Stars
npx skills add PatrickJS/awesome-cursorrules
Alternative
637 Stars
npx skills add sandbaseai/sandbase-harness --skill code-review
Alternative
11 Stars
npx skills add Bilalkhan4086/Skills-Learning
Alternative
4 Stars
npx skills add szarkans/multi --skill code-review
Agent safety v2
This skill should not be selected by an agent without explicit human security review.
Do not auto-install. Inspect the source, dependencies, and permission surface first.
high
Skill metadata references terminal, CLI, shell, subprocess, or command execution workflows.
medium
Skill likely fetches remote pages, APIs, repositories, or external services.
medium
Skill may read or write project files, documents, generated artifacts, or local workspace state.
high
Skill metadata references credentials, tokens, environment variables, or secret-bearing workflows.
Agent resolve plan
The Resolve API returns the selected skill, alternatives, safety policy, audit notes, install target, and copy-paste prompt an agent can follow without scraping this page.
Open JSON
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Resolve text
/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium&format=text
Install handoff
/api/skills/tidyfactor-doc/install
Agent should check
Copy prompt
Task: Use tidyfactor-doc in this workspace.
Resolve first: https://www.openagentskill.com/api/agent/resolve?task=Use%20tidyfactor-doc%20for%20an%20agent%20workflow&agent=codex&max_risk=medium
Review install handoff: https://www.openagentskill.com/api/skills/tidyfactor-doc/install
Install command: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Before running it, summarize audit warnings, required permissions, and the fallback skill if install is risky.Agent handoff
Use the public install endpoint to fetch the command, safety checklist, target prompts, and canonical links for this skill.
Install handoff
/api/skills/tidyfactor-doc/install
LLM text format
/api/skills/tidyfactor-doc/install?format=text
Find alternatives
/api/skills/search?q=tidyfactor-doc&limit=3
Agent prompt
Use tidyfactor-doc for this task. Review https://www.openagentskill.com/api/skills/tidyfactor-doc/install, then install with: npx skills add TidyFactor/Doc --skill tidyfactor-docRegistry metadata
This page exposes the same decision, trust, audit, use-case, and install signals through the Registry API, so agents can rank this skill without scraping the UI.
Manifest
/api/registry/manifest/tidyfactor-doc
LLM text
/api/registry/manifest/tidyfactor-doc?format=text
Install alias
/api/registry/install/tidyfactor-doc
Recommend
/api/registry/recommend?task=Use%20tidyfactor-doc%20in%20an%20agent%20workflow&limit=3
Agent fit
Local desktop
Use-case tags
Platforms
Claude Code
Audit report
A machine-readable review of install readiness, security metadata, maintenance, and adoption risk.
Agent decision cockpit
Do a manual repository review before adding this to an agent workflow.
Role in stack
Needs validation
Primary fit
Local desktop
Trust label
Needs manual review
Install path
Command ready
Use when
Evidence
review first
Implementation path
Trust profile
Trust Score v5 found insufficient evidence for agent installation. Treat this as discovery material, not an executable recommendation.
GitHub adoption
FIX1 GitHub stars
Stars/forks activity
FIX1 stars, 0 forks; issue activity unavailable in current metadata
Recent maintenance
PASS5d since push
License clarity
PASSNOASSERTION
Good signals
Review before install
Recommended action
Choose a stronger alternative or inspect the source manually before any install attempt.
Quality profile
Useful candidate, but compare it with alternatives before adopting.
Workflow fit
Operate local tools
I need my agent to operate local files and desktop apps in a repeatable workflow.
Parse messy files
I need my agent to read PDFs, extract tables, and turn documents into structured data.
Publish consistently
I need my agent to turn research and product updates into useful content drafts.
Workflow fit
Turn skills into distribution
A workflow for turning newly indexed skills into SEO briefs, social drafts, comparison pages, and reusable publishing workflows.
Inspect, patch, and verify code
A workflow for software agents that inspect repositories, review pull requests, generate tests, and turn findings into shippable patches.
Operate and verify web apps
A workflow for agents that navigate products, fill forms, take screenshots, and verify real user flows across web applications.
Alternative shortlist
Similar skills that may fit this task.
A curated collection of cursor rules for various frameworks and technologies
Reviews a supplied code path or diff for correctness, security, maintainability, and style without executing or modifying it
>-
--- name: tidyfactor-doc description: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews codebases (source comments, Git history, env requirements, error patterns) to generate accurate, maintainable docs under /docs — API references, READMEs, inline comments, and technical guides. Supports interactive doc portal generation with static compilation (MkDocs Material with native Arabic RTL i18n & Neo-Brutalist themes) or zero-build lightweight SPAs (Docsify). Trigger on commands "init", "collect", "generate", "site", "mkdocs", "docsify", or requests like "document this repo", "write API docs", "generate a README", "add JSDoc/PHPDoc", "publish doc portal", "set up MkDocs", "set up Docsify". Has stack-specific rules for PHP, JavaScript, TypeScript, React/Vue/Next. ---
# TidyFactor Doc
A command dispatcher. This file does not do the work itself — it routes to the right command, which routes to the right workflow, which injects the right memory.
## Commands
| User intent | Command | What it loads | |---|---|---| | "Set up docs for this project" / "scaffold /docs" | `references/commands/init.md` | `workflows/init-docs.md` + `memory/doc-tree.md` | | "Document this codebase" / "gather what's needed to document X" | `references/commands/collect.md` | `workflows/collect.md` + `memory/collection-sources.md` | | "Write API docs" / "generate a README" / "add inline comments" / "write a guide" | `references/commands/generate.md` | `workflows/generate-api.md` (or `generate-readme.md` / `generate-inline.md` / `generate-guide.md`) + `memory/doc-templates.md` + matching `memory/stacks/*.md` | | "Publish documentation portal" / "turn /docs into a doc site" (Interactive) | `references/commands/site.md` | `memory/site-engines.md` + interactive selection (`workflows/mkdocs.md` or `workflows/docsify.md`) | | "Set up MkDocs Material" / "compile static documentation" | `references/commands/mkdocs.md` | `workflows/mkdocs.md` + `memory/mkdocs-config.md` | | "Set up Docsify" / "build lightweight zero-build doc SPA" | `references/commands/docsify.md` | `workflows/docsify.md` + `memory/docsify-config.md` |
Read only the command file that matches the request. Do not read all commands simultaneously.
## Non-negotiable constraints on every command
1. **All generated documentation lives under `/docs`.** Never write API references, guides, or generated READMEs to another location. (`README.md` itself stays at the project root, per convention — everything else generated goes in `/docs`.) 2. **`generate` never invents content.** It only writes docs from what `collect` gathered (or equivalent detail the user supplies directly in the conversation) — never from assumed signatures, assumed env vars, or assumed behavior. If required detail is missing, `generate` says what's missing and asks or falls back to running `collect` first. 3. **Stack rules are looked up, never guessed.** Before writing any code-level doc (API reference, inline comments), load the matching file under `memory/stacks/` for the language/framework actually in use. Do not mix PHPDoc conventions into a TypeScript file or vice versa. 4. **`site`, `mkdocs`, and `docsify` only organize and publish what's already in `/docs`.** They never author new documentation content — that's `generate`'s job. - For **MkDocs Material**: Generate standard `mkdocs.yml`, configure Neo-Brutalist CSS tokens (`extra.css`), configure Arabic/English i18n (`*.ar.md` suffix), and build cleanly with `mkdocs build --strict`. - For **Docsify**: Include `alias: { '/.*/_sidebar.md': '/_sidebar.md' }` and root-relative leading slashes `/` in `_sidebar.md` to guarantee persistent sidebar navigation across all subfolder routes. 5. **Standalone.** This skill does not read or depend on any other `tidyfactor-*` skill's conventions, even when the project happens to be built on one of those tracks. 6. **Zero Sensitive Data Leakage.** Under absolutely no circumstances should any real sensitive data (e.g., real API tokens, WHM/cPanel passwords, production server IPs, real DB credentials, secret keys, private auth tokens, or local absolute drive paths) be written into documentation. ALWAYS redact and replace these with safe generic placeholders. 7. **Clean Relative Links Only.** Never include local machine filesystem URLs (such as `file:///C:/...`, `file:c:`, or absolute workstation paths) in documentation links or markdown cross-references. All document cross-links must use clean relative markdown paths or standard public web URLs (`https://...`).
## Sequencing
`init` → `collect` → `generate` (repeatable, once per doc target) → `site` / `mkdocs` / `docsify` (optional, once /docs has real content).
Decision snapshot
recent repository activity
Audit
Install and adoption review
Agent-proven evidence
Outcome reports after resolve, review, install, and one narrow run.
No agent outcome data yet. The first agent run can report success, setup needs, risk blocks, failure, or not-relevant through /api/agent/outcome.
Install
Free and open source. Review the report before installing into production agents.
Growth loop
Scenario-led draft for tidyfactor-doc, ready for a manual X post.
A practical pick for a web workflow: tidyfactor-doc: TidyFactor Doc — code documentation builder and dual-engine publishing platform (MkDocs Material & Docsify). Interviews cod... 1 stars https://www.openagentskill.com/skills/tidyfactor-doc?ref=x
Listing + install path for tidyfactor-doc: https://www.openagentskill.com/skills/tidyfactor-doc?ref=x Install: npx skills add TidyFactor/Doc --skill tidyfactor-doc
Listing source
This listing was indexed from public sources and is not marked official until a maintainer claim is approved.
Attribution links to the public repository or creator profile. Creators can claim the listing to update ownership signals.
Claim this skillOwner claim
This Community submitted listing is attributed to TidyFactor but is not marked official yet. Claim it to add a verified owner signal and make future launch, install, and audit updates easier to trust.
Creator backlink kit
Show the canonical listing, current trust and audit signals, and real Agent-Proven evidence where developers evaluate the repository.
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc)
[](https://www.openagentskill.com/skills/tidyfactor-doc/audit)
[](https://www.openagentskill.com/skills/tidyfactor-doc)Share whether this skill looks useful for your agent workflow. Aggregated feedback improves rankings over time.
Do not auto-install
Permission surface
secrets or environment access, shell or command execution
Agent outcomes
No agent outcome data yet
Docs
Strong README/SKILL.md context
Risk summary
Install readiness
Permission surface
secrets or environment access, shell or command execution
Agent outcomes
No agent outcome data yet
Docs
Strong README/SKILL.md context
Risk summary
Install readiness
Permission surface
secrets or environment access, shell or command execution
Agent outcomes
No agent outcome data yet
Docs
Strong README/SKILL.md context
Risk summary
Install readiness
Permission surface
secrets or environment access, shell or command execution
Agent outcomes
No agent outcome data yet
Docs
Strong README/SKILL.md context
Risk summary
Install readiness