You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b15de97
Browse filesBrowse the repository at this point in the historyBrowse files
Build docs from PlanExe2 docs/website/ instead of PlanExe v1
Drop the v1 nav, component README copying, nav-status CSS and proposals
nav injection. v1 docs remain readable in PlanExe/docs on GitHub.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: README.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,13 @@ This repository contains the built documentation for [PlanExe](https://planexe.o
4
4
5
5
## Overview
6
6
7
-
The documentation source files are maintained in the main [PlanExe repository](https://github.com/PlanExeOrg/PlanExe) in the `docs` directory. This repository contains the compiled output from MkDocs Material, which is automatically deployed to GitHub Pages.
7
+
The documentation source files are maintained in the [PlanExe2 repository](https://github.com/PlanExeOrg/PlanExe2) in the `docs/website/` directory. Only that directory is published; the rest of `PlanExe2/docs/` is internal. This repository contains the build configuration; MkDocs Material output is deployed to GitHub Pages.
8
+
9
+
The PlanExe v1 documentation is no longer published here; it remains readable in [PlanExe/docs](https://github.com/PlanExeOrg/PlanExe/tree/main/docs).
See `.github/workflows/deploy.yml` for GitHub Actions automation.
98
100
99
-
**Why doesn’t the site rebuild when I push docs changes in PlanExe?**
101
+
**Why doesn’t the site rebuild when I push docs changes in PlanExe2?**
100
102
101
-
The docs site is built and deployed from **this** repo (PlanExe-docs). Pushing to the **PlanExe** repo does not run workflows here. Rebuilds happen when:
103
+
The docs site is built and deployed from **this** repo (PlanExe-docs). Pushing to **PlanExe2** does not run workflows here. Rebuilds happen when:
102
104
103
-
1.**Someone pushes to `main` on PlanExe-docs** (this repo), or
104
-
2.**Someone manually runs** the “Deploy Documentation” workflow in PlanExe-docs (Actions → Deploy Documentation → Run workflow), or
105
-
3.**The PlanExe repo triggers a rebuild**when `docs/` changes on `main`.
105
+
1.**Someone pushes to `main` on PlanExe-docs** (this repo), or
106
+
2.**Someone manually runs** the “Deploy Documentation” workflow in PlanExe-docs (Actions → Deploy Documentation → Run workflow), or
107
+
3.**A `repository_dispatch` of type `docs-updated`**is sent to this repo.
106
108
107
-
For (3), the [PlanExe repo](https://github.com/PlanExeOrg/PlanExe) has a workflow (`.github/workflows/docs-update.yml`) that sends a `repository_dispatch` to this repo when files under `docs/` change. For that to work you must configure a secret in the **PlanExe** repo named **`PLANEXE_DOCS_DISPATCH_TOKEN`** (PlanExe → Settings → Secrets and variables → Actions).
109
+
PlanExe2 has no workflow that sends (3) yet, so after merging docs changes in PlanExe2, use (2). To automate it, add a workflow to PlanExe2 that sends the dispatch when `docs/website/**` changes on `main`, with a secret named **`PLANEXE_DOCS_DISPATCH_TOKEN`** (PlanExe2 → Settings → Secrets and variables → Actions). The PlanExe v1 repo has such a workflow (`.github/workflows/docs-update.yml`) that can be used as a template; while it is active, v1 docs changes also trigger a (harmless) rebuild of this site.
108
110
109
111
**Token value:** use a GitHub Personal Access Token that can trigger workflows in this repo. A **fine-grained** token is recommended (narrower permissions). Fine-grained tokens have a **maximum expiration of 1 year**, so the secret must be renewed annually.
110
112
@@ -114,20 +116,20 @@ For (3), the [PlanExe repo](https://github.com/PlanExeOrg/PlanExe) has a workflo
114
116
2.**Generate new token** (or open an existing one to regenerate/check expiry).
115
117
3.**Token name:** e.g. `PlanExe docs dispatch`.
116
118
4.**Expiration:** set the maximum (1 year); add a calendar reminder to renew before it expires.
117
-
5.**Resource owner:** your user or the org that owns PlanExe.
119
+
5.**Resource owner:** your user or the org that owns PlanExe2.
118
120
6.**Repository access:** Only select repositories → choose **PlanExeOrg/PlanExe-docs**.
119
121
7.**Permissions → Repository permissions:** set **Contents** to **Read and write** (required for the `repository_dispatch` API; Actions alone is not enough).
120
-
8. Generate the token, copy it (it is shown only once), then in the **PlanExe** repo update the **`PLANEXE_DOCS_DISPATCH_TOKEN`** secret with this value.
122
+
8. Generate the token, copy it (it is shown only once), then in the source repo update the **`PLANEXE_DOCS_DISPATCH_TOKEN`** secret with this value.
121
123
122
124
**Alternative:** a [classic PAT](https://github.com/settings/tokens) with **`repo`** scope also works and can have a longer or no expiration.
123
125
124
-
If the secret is missing or expired, the “Notify docs deploy” job in PlanExe will fail and the site will not rebuild. Until the token is set, use option (2) and manually run “Deploy Documentation” in PlanExe-docs after merging docs changes.
126
+
If the secret is missing or expired, the “Notify docs deploy” job in the source repo will fail and the site will not rebuild. Until then, use option (2).
125
127
126
128
**Troubleshooting deployment**
127
129
128
130
The main place to check is the **PlanExe-docs Actions** page: **[github.com/PlanExeOrg/PlanExe-docs/actions](https://github.com/PlanExeOrg/PlanExe-docs/actions)**. There you can see all workflow runs: “Deploy Documentation” (builds the site and deploys to GitHub Pages) and “pages build and deployment” (GitHub’s Pages publish). Runs triggered by a docs change in PlanExe show the event **docs-updated** and “Repository dispatch triggered by …”. Use this page to confirm a deploy ran, re-run a failed workflow, or manually start “Deploy Documentation” (Actions → Deploy Documentation → Run workflow).
129
131
130
-
-**Site didn’t update after pushing to PlanExe/docs?** Open the [PlanExe-docs Actions](https://github.com/PlanExeOrg/PlanExe-docs/actions) page. If there is no “Deploy Documentation” run for your push, the trigger from PlanExe likely failed — check the [PlanExe Actions](https://github.com/PlanExeOrg/PlanExe/actions) tab: a failed “Notify docs deploy” job will show the API error (e.g. token missing **Contents: Read and write**). If “Deploy Documentation” ran but failed, open that run and fix the error shown in the logs. If it succeeded, wait a minute or two for GitHub Pages to update and try a hard refresh (Ctrl+Shift+R / Cmd+Shift+R) or a private window to avoid cache.
132
+
-**Site didn’t update after pushing to PlanExe2/docs/website?** Open the [PlanExe-docs Actions](https://github.com/PlanExeOrg/PlanExe-docs/actions) page. If there is no “Deploy Documentation” run for your push, the trigger from PlanExe likely failed — check the [PlanExe Actions](https://github.com/PlanExeOrg/PlanExe/actions) tab: a failed “Notify docs deploy” job will show the API error (e.g. token missing **Contents: Read and write**). If “Deploy Documentation” ran but failed, open that run and fix the error shown in the logs. If it succeeded, wait a minute or two for GitHub Pages to update and try a hard refresh (Ctrl+Shift+R / Cmd+Shift+R) or a private window to avoid cache.
131
133
-**“Notify docs deploy” succeeded in PlanExe, but no “Deploy Documentation” run appears in PlanExe-docs?** The dispatch API may have rejected the request (e.g. 403). Fine-grained tokens need **Contents: Read and write** on PlanExe-docs; **Actions** alone is not enough. Update the token with that permission and update **`PLANEXE_DOCS_DISPATCH_TOKEN`** in the PlanExe repo. After the change, the PlanExe workflow fails the job and prints the API response when the dispatch is rejected, so the exact error will appear in [PlanExe Actions](https://github.com/PlanExeOrg/PlanExe/actions).
132
134
133
135
## Configuration
@@ -136,15 +138,15 @@ The MkDocs configuration is in `mkdocs.yml`. Key settings:
136
138
137
139
-**Site URL**: https://docs.planexe.org
138
140
-**Theme**: Material for MkDocs
139
-
-**Source**: Points to PlanExe repo's `docs` directory
141
+
-**Source**: Points to PlanExe2 repo's `docs/website` directory
140
142
141
143
## Contributing
142
144
143
145
To contribute to the documentation:
144
146
145
-
1. Edit files in the [PlanExe repository's `docs` directory](https://github.com/PlanExeOrg/PlanExe/tree/main/docs)
147
+
1. Edit files in the [PlanExe2 repository's `docs/website` directory](https://github.com/PlanExeOrg/PlanExe2/tree/main/docs/website)
146
148
2. Build and test locally using the instructions above
147
-
3. Submit a pull request to the PlanExe repository
149
+
3. Submit a pull request to the PlanExe2 repository
148
150
4. After merging, rebuild and deploy to this repository
0 commit comments