Update Flow
This page documents **which repositories publish updates to which**, including how this documentation site stays in sync with the source projects.
Update Flow
This page documents which repositories publish updates to which, including how this documentation site stays in sync with the source projects.
Repository map
| Repository | Owner | Role |
|---|---|---|
| BartoszOsiej/Shortlink | BartoszOsiej (fork of ghost0development) | Source: LinkShort URL shortener |
| BartoszOsiej/Factorio-web-game | BartoszOsiej | Source: Novactorio browser game |
| BartoszOsiej/NV2_ENGINE | BartoszOsiej | Source: NV2 Engine β native Rust voxel game |
| BartoszOsiej/Aurora | BartoszOsiej | Source: Aurora β browser operating system in TypeScript |
| BartoszOsiej/CyberForge | BartoszOsiej | Source: CyberForge β 4 Rust security tools |
| BartoszOsiej/talus-process-monitor | BartoszOsiej | Source: Talus β eBPF endpoint security |
| BartoszOsiej/externum | BartoszOsiej | Source: Externum language |
| BartoszOsiej/Meshcore | BartoszOsiej | Source: Meshcore β P2P chat (own GitHub Pages site) |
| BartoszOsiej/Docs | BartoszOsiej | This site β GitHub Pages docs hub |
Update flow diagram
ββββββββββββββ ββββββββββββββ ββββββββββββββ ββββββββββββββββ
β FastAPI-urlβ β Factorio- β β NV2_ENGINE β β cybersec- β
β (LinkShort)β β web-game β β (NV2 Eng) β β tools β
βββββββ¬βββββββ βββββββ¬βββββββ βββββββ¬βββββββ ββββββββ¬ββββββββ
β docs updates β docs updates β docs updates β docs updates
βΌ βΌ βΌ βΌ
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β BartoszOsiej/Docs β
β (this GitHub Pages site) β
βββββββββββββββββββββββββββββββ¬βββββββββββββββββββββββββββββββββ
β git push (main)
βΌ
GitHub Actions
build + deploy
β
βΌ
https://bartoszosiej.github.io/Docs/How updates reach this site
| # | Source repo | What flows in | When |
|---|---|---|---|
| 1 | FastAPI-url | API changes, new endpoints, feature updates | When the API or SPA changes |
| 2 | Factorio-web-game | Engine/systems/backend documentation changes | When gameplay or backend changes |
| 3 | NV2_ENGINE | Engine, AI, gameplay and performance documentation | When the engine changes |
| 4 | cybersec-tools | Tool docs, usage, CLI reference | When a tool changes |
| 5 | talus-process-monitor | eBPF architecture & usage docs | When the monitor changes |
| 6 | Externum | Language spec, syntax, compiler & runtime docs | When the language changes |
| 7 | Docs (this repo) | Final rendered site | On every push to main |
Publishing a docs update (source repos)
- Edit the Markdown under the relevant project's section in
Docs:projects/fastapi-url/β LinkShortprojects/factorio-web-game/β Novactorioprojects/nv2-engine/β NV2 Engineprojects/cybersec-tools/β CyberForgeprojects/talus-process-monitor/β Talusprojects/externum/β Externum (5 pages)
- Commit to the
Docsrepository and push tomain. - GitHub Actions builds the Docusaurus site and deploys it to GitHub Pages automatically β no manual steps.
Note: The documentation lives in the
Docsrepository (single source of truth for the site). The source projects publish facts (code changes); the docs are updated in this repo. If you prefer docs to live next to the code, each source repo can hold its owndocs/folder and a workflow can mirror it here β see "Alternative pattern" below.
Alternative pattern: docs-in-source mirror
If you want documentation to live inside each source repo and auto-sync:
FastAPI-url/docs/*.md βββ
ββββΊ (GitHub Action: copy docs/ β Docs repo) βββΊ Docs
Factorio-web-game/docs/*.md βββA workflow in each source repo would checkout Docs, copy its docs/
folder, commit, and push. This keeps docs next to the code they describe,
with this site as the rendered output.
Deployment pipeline (this repo)
| Stage | Detail |
|---|---|
| Static site generator | Docusaurus (React) |
| Build | npm run build |
| Publish | GitHub Actions β actions/deploy-pages |
| URL | bartoszosiej.github.io/Docs/ |
GitHub account note
BartoszOsiejis the current account;ghost0developmentis the older account from whichFastAPI-urlwas forked.- Local clones of
FastAPI-urltrackorigin=BartoszOsiejandupstream=ghost0development(for pulling upstream fixes).