Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
826 changes: 826 additions & 0 deletions ARCHITECTURE.md

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ Push is early software. Please read the [security policy](SECURITY.md) before
reporting a vulnerability. Bug reports, ideas, and pull requests are welcome.

- [Contributing](CONTRIBUTING.md)
- [Architecture](ARCHITECTURE.md)
- [Code of conduct](CODE_OF_CONDUCT.md)
- [Security policy](SECURITY.md)
- [MIT license](LICENSE)
422 changes: 0 additions & 422 deletions docs/architecture.md

This file was deleted.

4 changes: 3 additions & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ cargo test --locked
| Durable user questions | `src/approval.rs`, `src/history.rs` |
| Production diagnostics | `src/doctor.rs`, `src/audit.rs` |

Read [architecture](architecture.md) before changing state, crash recovery,
Read the
[architecture](https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md)
before changing state, crash recovery,
channel cursors, session ownership, scheduling, or delivery semantics.

## Documentation workflow
Expand Down
4 changes: 3 additions & 1 deletion docs/core-system/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
!!! warning "Historical record"

This file preserves the approved design and rollout sequence. It is not a
current roadmap. See [Architecture](../architecture.md) for shipped behavior.
current roadmap. See the
[architecture](https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md)
for shipped behavior.

**Author:** Owain Lewis **Date:** 2026-07-11

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,4 +181,4 @@ a Telegram- or Slack-only Linux host.
- [Configure both channels and per-thread routes](configuration.md)
- [Create a manual or scheduled job](jobs.md)
- [Inspect every CLI command](reference/cli.md)
- [Understand durable state and recovery](architecture.md)
- [Understand durable state and recovery](https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md)
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ tools, skills, and authentication. Chats preserve configured agent permissions;
Codex and Claude jobs bypass interactive permissions so scheduled work can
finish without an operator.

[See the full architecture](architecture.md){ .push-inline-link }
[See the full architecture](https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md){ .push-inline-link }

</section>

Expand Down Expand Up @@ -179,7 +179,7 @@ finish without an operator.
| choose backend permissions safely | [Permissions and security](security.md) |
| keep Push online after logout or reboot | [Run as a service](services.md) |
| inspect commands and outputs | [CLI reference](reference/cli.md) |
| understand or extend the code | [Architecture](architecture.md) and [contributing](contributing.md) |
| understand or extend the code | [Architecture](https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md) and [contributing](contributing.md) |

!!! note "Canonical source"

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ nav:
- Run as a service: services.md
- Reference:
- CLI commands: reference/cli.md
- Architecture: architecture.md
- Architecture: https://github.com/owainlewis/push/blob/main/ARCHITECTURE.md
- Develop:
- Contributing: contributing.md
- Product strategy: strategy.md
Expand Down
2 changes: 1 addition & 1 deletion tests/docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use pulldown_cmark::{Event, Options, Parser, Tag, TagEnd};
#[test]
fn local_documentation_links_resolve() {
let root = Path::new(env!("CARGO_MANIFEST_DIR"));
let mut markdown = vec![root.join("README.md")];
let mut markdown = vec![root.join("README.md"), root.join("ARCHITECTURE.md")];
collect_markdown(&root.join("docs"), &mut markdown);

let mut broken = Vec::new();
Expand Down
Loading