General
PromptBeginner5 minmarkdown
<h1 align="center">
<a href="https://prompts.chat">
5
Internal guide for maintaining and improving Instructor documentation
Sign in to like and favorite skills
uv run mkdocs serve./build_mkdocs.sh or uv run mkdocs builduv pip install -e ".[docs]"uv run pytest docs/ --examplesconcepts/, integrations/, examples/getting-started.md → learning/ → tutorials/mkdocstringsblog/posts/ for announcements and deep-divestemplates/ for new docs (provider, concept, cookbook)templates/ patternsmkdocs.yml for new pagesUse Conventional Commits formatting for PR titles so they are consistent and easy to scan. Treat the PR title as the message we would use for a squash merge commit.
Use:
<type>(<scope>): <short summary>
Rules:
! after the type or scope (for example, feat(docs)!:).Good examples:
docs(agents): add conventional commit PR title guidelinesdocs(mkdocs): fix broken link in validation tutorialdocs(examples): update youtube clips snippetchore(docs): refresh docs build commandsCommon types:
docs: documentation-only changesfix: bug fixfeat: new featuretest: add or update testschore: maintenance work (build scripts, tooling, repo hygiene)ci: CI pipeline changesSuggested docs scopes:
docs, mkdocs, blog, examples, integrations, tutorials, agentsKeep PR descriptions short and actionable:
If the PR was authored by Cursor, include:
This PR was written by [Cursor](https://cursor.com)mkdocs.yml - Site configuration and navigationhooks/ - Custom processing (hide_lines.py removes # <%hide%> markers)overrides/ - Custom theme elementsjavascripts/ - Client-side enhancements