Skip to content

Commit a9c8b11

Browse files
committed
Add project structure section
1 parent 0953185 commit a9c8b11

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ This repo contains the documentation for the Runa Developer Hub aka API Docs. Th
44

55
This repository is publicly hosted at https://github.com/wegift/api-docs.
66

7+
## Project Structure
8+
9+
- `assets` contains graphics and screenshots
10+
- `bin` contains scripts
11+
- `best-practices` contains pages under 'Best Practices'
12+
- `changelog` contains pages under 'Changelogs'
13+
- `features` contains the feature guides
14+
- `getting-started` contains the getting started guides
15+
- `reference` contains the API reference pages including the OpenAPI spec for each version of the API
16+
- `snippets` contains reusable content for all pages
17+
- `styles` contains configuration for the spell checker
18+
- `docs.json` contains the configuration for the docs, new pages need to be referenced in this file
19+
- `introduction.mdx` is the root page of the guides section
20+
- `welcome.mdx` is the home page of the site
21+
722
## Writing
823

924
Read https://mintlify.com/guides

0 commit comments

Comments
 (0)