Project structure

The Stainless Docs Platform uses Starlight’s project structure and Astro’s routing capabilities.

Starlight expects your content to be in src/content/docs, but Astro without Starlight looks for content in src/content and pages in src/content/pages. If you’re looking at Astro’s documentation, it’s important to keep this difference in mind.

When you create a new Stainless Docs Platform site, your repo will contain the following files and folders, which form the structure of your site and define its configuration:

📁 <root>
├─ 📁 public/
├─ 📁 src/
│  ├─ 📁 assets/
│  └─ 📁 content/
│     └─ 📁 docs/
├─ 📄 astro.config.ts
└─ 📄 package.json

Briefly:

• public/ - Static assets like your site’s favicon. These are not processed by Astro or the Stainless Docs Platform and are served at the root of your site.
• src/assets/ - Images, fonts, and other assets used in your site. Put images, video, audio, and other assets used in your prose content here.
• src/content/docs/ - Your prose pages in Markdown, Markdoc, or MDX format.
• astro.config.ts - The primary configuration file for your project. This file contains your site’s configuration for Astro and the Stainless Docs Platform.
• package.json - Your project’s manifest file. This file contains your project’s dependencies and scripts.

In addition, there are additional support files and folders, like the README.md file, the node_modules folder, and others.

For more information about your site’s structure, have a look at Astro’s project structure documentation.