Add a Docs Section with a Sidebar with AI
A help section for your product or service: grouped pages in a sidebar, a contents list on each page and a search box.
What you need
- A site on SiteShip
- Your section names and the pages in each, in the order you want them
- The facts for each page: your AI writes from what you give it
The prompt
Add a docs section to my SiteShip site [site name] at /docs, in my site's style, and add Docs to the menu.
Sections and pages, in this order: [Getting started: Install, First steps] [Using it: Settings, Sharing] [Billing: Plans, Cancel and refunds].
How to build it: keep the sections and their pages in one list (a data file) and build the sidebar from that list, with the current page marked. Write each page as a Markdown file in pages/docs/ with a title and a one-line summary. Give the pages one shared layout with: the sidebar on the left (behind a "Docs menu" button on phones), a breadcrumb, an "On this page" list made from the page's headings, previous and next links that follow the sidebar order, and a search box that searches the docs. Make a docs home page that lists every section and page, with a box that narrows the list as I type.
Write these pages now, from the facts below, and list only pages that exist in the sidebar: [page: the facts for it] [page: the facts for it]. Use only the facts I've given you; ask me if something is missing. Show me the preview before anything goes live.
Fill in the [brackets] with your details.
What you get
- A docs home page and a page for each topic, all in your site's style
- A sidebar built from one list, so adding a page later is one new line and one new file
- An "On this page" list, previous and next links and a search box on every docs page
- Each page in your sitemap and in your site's search, with its own title and description
Good to know
- Search looks at page titles and one-line summaries, not the full text, so write summaries in the words your customers use.
- The "On this page" list comes from the headings in each page. A page needs at least two headings for it to show.
- If your old site had help pages, give your AI their addresses so it can point them at the new ones.
Not connected yet?