Athenian DevDocs
product details.
Athenian DevDocs scans plugin code and source assets, uses AI-assisted templates to generate structured documentation, and publishes marketing and developer docs through a polished front-end layer. It helps teams turn internal plugin knowledge into maintainable documentation for admins, developers, support teams, and customers while keeping data, permissions, and automation aligned with the broader Athenian Platform…
Athenian DevDocs is a WordPress and WooCommerce documentation operations plugin for turning installed plugin code, ZIP/source attachments, product context, AI prompt templates, and structured documentation schemas into polished marketing and developer documentation.
The plugin is built for plugin-heavy product environments where documentation needs to stay closer to the code. It registers a public ath_devdoc documentation content type, provides admin screens for scanning installed plugins, stores source-aware manifests and release snapshots, supports AI-assisted documentation generation, and renders front-end documentation pages with marketing and developer sections side by side.
Instead of rebuilding plugin documentation from memory, scattered notes, README files, support conversations, or release messages, DevDocs gives teams a native WordPress workflow for scanning, snapshotting, generating, reviewing, linking, and publishing documentation from one canonical source.
Within the Athenian Platform, DevDocs fits as the product documentation layer for the broader plugin portfolio, connecting engineering implementation, customer-facing product pages, developer references, support material, WooCommerce product tabs, release documentation, and AI-assisted documentation operations.
Code-Aware Documentation
Scan Installed Plugins and Capture Documentation-Ready Technical Context
Athenian DevDocs can inspect installed WordPress plugins, inventory source
files, extract implementation signals, store manifests, and create versioned
ZIP snapshots so documentation starts from the plugin’s real structure
instead of disconnected notes.
| Scanning Layer | Operational Value |
|---|---|
| Installed Plugin Browser | Adds a DevDocs plugin page where administrators can scan plugins, create or update linked DevDocs, snapshot ZIPs, and open plugin records. |
| Static Manifest | Captures plugin headers, file inventory, hashes, PHP symbols, hooks, filters, shortcodes, and REST routes. |
| Versioned Storage | Saves manifests and snapshots under organized upload paths using plugin slug, version, and timestamp. |
| Release Snapshot Workflow | Creates ZIP snapshots of installed plugin folders while excluding common heavy or development-only directories. |
- Stores generated files under
wp-content/uploads/ath-devdocs/, includingmanifests/,snapshots/, and reserved generated-output paths. - Stores plugin metadata on DevDoc posts using keys such as
_ath_devdoc_plugin_file,_ath_devdoc_plugin_slug,_ath_devdoc_plugin_version,_ath_devdoc_manifest_json, and_ath_devdoc_snapshots_json. - Uses a best-effort analyzer to extract classes, interfaces, traits, functions, public methods, hooks, filters, shortcodes, and REST routes from PHP files.
- Supports roadmap expansion toward manifest diffs, release-note generation, AST parsing, GitHub/GitLab scanning, and stale-documentation detection.
AI-Assisted Documentation
Generate Reviewable Marketing and Developer Docs From Structured Source Context
DevDocs stores documentation as canonical JSON, supports source attachment
extraction, registers reusable AI template records, and can generate
structured marketing and developer documentation through ASAKM or direct
OpenAI routing.
Keep marketing, developer, FAQ, changelog, metadata, and CTA content together
Reuse system prompts, user prompts, and output schemas across plugin docs
Generate drafts from ZIPs, READMEs, code files, docs, notes, and manifests
| Documentation Layer | How It Helps |
|---|---|
| DevDoc CPT | Registers public ath_devdoc records that store structured documentation and publish under the /devdocs archive. |
| AI Template CPT | Registers ath_dd_template for reusable prompts, output schemas, revisions, and generation contracts. |
| Layout Presets | Registers ath_doc_preset records for front-end layout configuration such as basic sections or marketing/developer tabs. |
| Generation Modes | Supports ASAKM proxy mode and direct OpenAI mode for AI-assisted documentation generation. |
- Stores canonical documentation data in
_ath_devdoc_json. - Stores source attachment IDs and extraction notes in
_ath_devdoc_sourcesand_ath_devdoc_source_notes. - Uses settings under
ath_devdocs_settingsfor AI mode, model, endpoint, ASAKM proxy URL, default preset, and front-end style options. - Current implementation notes call out a legacy source-extraction route mismatch that should be reconciled before relying on the legacy Extract + Generate button in production.
Published Documentation Experience
Publish Polished Marketing and Developer Documentation Inside WordPress
Athenian DevDocs renders structured documentation into a polished front-end
layout with hero content, tabs, feature cards, developer references, FAQs,
changelog entries, linked products, shortcodes, and WooCommerce product
documentation tabs.
| Publishing Surface | Operational Purpose |
|---|---|
| Front-End Renderer | Displays structured docs with hero sections, badges, marketing/developer tabs, table of contents, feature cards, API references, FAQs, and changelog sections. |
| Shortcode Output | Supports rendering a single DevDoc or a product-aware list of DevDocs from WordPress content areas. |
| WooCommerce Product Tabs | Adds a Documentation tab to product pages when published DevDocs are linked to the current WooCommerce product. |
| REST Workflows | Provides endpoints for saving JSON, rendering previews, scanning plugins, creating DevDocs, snapshotting plugins, product search, and AI generation. |
One source for product and developer docs:
DevDocs helps teams keep customer-facing product messaging and technical
implementation references aligned, reviewable, and publishable from
inside the same WordPress documentation record.
- Supports shortcode names such as
'ath_devdoc'and'ath_devdocs'. - Links DevDocs to WooCommerce products through
_ath_devdoc_product_idsand_ath_devdoc_product_ids_index. - Registers REST routes under
/wp-json/ath-devdocs/v1, including/save-json,/render,/plugins,/scan-plugin,/ensure-doc,/snapshot-plugin, and/ai-generate-plugin. - Uses configurable renderer variables such as
--athdd-accent,--athdd-radius, and--athdd-font. - Builds toward visual schema editing, Gutenberg blocks, Markdown/HTML/JSON/PDF export, WP-CLI scan/snapshot/generate commands, approval workflows, documentation quality scoring, and Athenian Platform Core / Plugin Forge integration.