GitHub Pages Documentation Site Plan
Plan a documentation site structure and publishing workflow.
The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.
Plan a documentation site published with GitHub Pages. Project and audience: [PROJECT_AND_AUDIENCE]. Topics to cover: [TOPICS]. Tool for building the site, if any: [SITE_TOOL]. Who maintains it: [MAINTAINERS]. Draft the navigation as an indented outline with page titles that are verbs or questions rather than labels, covering getting started, guides, reference and FAQ. Write a page template with a short prompt under each heading, the home page, and a how-to page outline. Give a style guide of ten rules, such as one task per page and an example for every command. Describe the pull request workflow for documentation: a template, a reviewer who has not worked on the feature, a preview build, and a workflow that builds and publishes on merge [VERIFY steps and settings]. Check for broken links and spelling. Accessibility: heading order, link text, alt text, contrast. Add a checklist for each release (update version numbers, check links, run the examples), a plan to retire out-of-date pages with redirects from old addresses, and ways to learn what is useful (feedback links and search terms). Documentation should be versioned with the code.
Fill in before use
Optional: type your details and the prompt above updates. Nothing is saved or sent.
Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.