Skip to content

Commit 54de539

Browse files
docs: udpate doc, communicate clearly that "ap dev" only runs the project website shell
1 parent 51307bf commit 54de539

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

afterpython/doc/project_website.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ During `ap init`, `afterpython` creates a new directory `afterpython/_website/`
4747

4848
This approach brings us into the realm of full-stack web development, which enables us to add features such as an AI chatbot, full-text search engine across the website, etc.
4949

50+
:::{note} Development navbar behavior
51+
`ap dev` starts the project website only. In development, navbar links for MyST-backed sections are shown when their content dev servers are running, for example with `ap dev --doc`, `ap dev --tutorial`, or `ap dev --all`. In production builds and previews, the navbar is based on the generated site output, so sections appear after their content has been built.
52+
:::
53+
5054

5155
---
5256
## Website Template Update

afterpython/doc/quickstart.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ See [](project_website.md) for more details.
5555

5656
AfterPython provides two ways to work with content:
5757

58-
1. **Project Website Only** - Run `ap dev` to start the development server for your project website.
58+
1. **Project Website Only** - Run `ap dev` to start the development server for your project website shell.
5959

6060
2. **Individual Content Development** - Run `ap dev` with flags to work on specific content types:
6161
- `ap dev --doc` - Documentation
@@ -67,11 +67,15 @@ AfterPython provides two ways to work with content:
6767

6868
When using flags, a MyST development server starts for that specific content folder (e.g., `afterpython/doc/`), allowing you to write and preview content in `.md` or `.ipynb` files with live reload.
6969

70+
:::{note} Navigation tabs in development
71+
Plain `ap dev` runs only the project website, so content tabs such as **Documentation**, **Tutorials**, **Examples**, **Guides**, and **Blog** may not appear in the navbar. To preview those tabs while writing content, start the corresponding content server, for example `ap dev --doc --tutorial`, or use `ap dev --all`.
72+
:::
73+
7074
### Content Organization
7175

7276
All content folders in `afterpython/` (e.g., `afterpython/doc/`, `afterpython/blog/`) are initialized by `myst init` (see [MyST Markdown]), and **each** has a `myst.yml` file for configuration. Add your own `.md` or `.ipynb` files to a folder to start writing.
7377

74-
The `/blog`, `/tutorial`, `/example`, and `/guide` listing pages are rendered by the project website — don't add an `index.md` to those folders, it's reserved.
78+
The `/blog`, `/tutorial`, `/example`, and `/guide` listing pages are rendered by the project website — don't add an `index.md` to those folders, it's reserved. If a listing page has no posts yet, the project website can still render an empty-state page such as "No posts available yet."
7579

7680
:::{seealso}
7781
To learn more about how to arrange your content in the content folders, see [Table of Contents] or a [Quick Guide about myst.yml](myst.md).

0 commit comments

Comments
 (0)