oxfmt-oxlint skill

Overview

This skill provides an assistant for the OXFMT-OXLINT documentation set. It helps locate, read, and cite documentation files stored in the docs/ directory and formats answers with source attribution and fetch dates. Use it to quickly extract authoritative guidance from the project's documentation.

How this skill works

The skill searches the docs/ directory and returns passages or file references that match your query. It can run the repository search script to produce results, and it always includes the documented source URL and the fetched_at timestamp so responses remain traceable. When presenting answers, the skill appends the source and fetch metadata in the required response format.

When to use it

• You need a concise explanation from OXFMT-OXLINT docs.
• You want exact quotes or instructions from project documentation.
• You must provide traceable citations for compliance or review.
• You need to confirm whether documentation changed by checking fetch dates.
• You are preparing documentation-based answers that require source links and timestamps.

Best practices

• Search first: use targeted queries to narrow results before opening files.
• Always include the source_url and fetched_at metadata in answers to maintain traceability.
• Prefer quoting short passages and then summarizing in your own words to avoid misinterpretation.
• Limit results with --max-results when using the search script to reduce noise.
• Verify fetch dates against the live repository if the docs are critical and may have changed.

Example use cases

• Answer a question about configuration options by quoting the relevant docs file and citing its source URL and fetched_at timestamp.
• Summarize a troubleshooting entry from docs/ and provide the file link for further reading.
• Produce a compliance summary that lists exact documentation sources and when they were fetched.
• Run a targeted search for API or configuration keywords and return top matches with citations.

FAQ