Phx:Document
ListedExtracts structured data like tables, lists, and key-value pairs from documents using advanced OCR and AI parsing.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
phx-document, not the name it is listed under, so the command below uses that name.- 1
Run this in your project
terminal$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document --full-depth -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
oliver-kriska
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
We could not read this skill's source, so none of the checks below were run.
About this skill
What it does
The phx:document skill allows AI agents to generate documentation from Elixir Phoenix projects. It can extract information about routes, controllers, views, and models, structuring this data into human-readable markdown documents. This facilitates the creation of API references, project overviews, and developer onboarding materials directly from existing codebases.
When to use it
- Automated API Documentation: Quickly generate documentation for a Phoenix API endpoint without manual effort.
- Project Onboarding: Create comprehensive documentation for new developers joining a Phoenix project.
- Codebase Understanding: Generate an overview of the project's structure and components, aiding in code comprehension.
- Refactoring Documentation: Update documentation automatically when changes are made to the codebase.
Key capabilities
- Route extraction
- Controller information retrieval
- View details capture
- Model data representation
Example prompts
- "Generate API documentation for all routes in this Phoenix project."
- "Create a markdown document describing the controllers in my application."
- "Show me an overview of the models used in this Elixir Phoenix project."
Tips & gotchas
The skill requires access to the Elixir Phoenix codebase. Ensure the AI agent has appropriate permissions and context to read the relevant files for accurate documentation generation.