From 4f4d808bdc96ce1217137cb147d7515e822f92fd Mon Sep 17 00:00:00 2001 From: Jarvis Jr Hermes Date: Fri, 2 Oct 2026 10:38:44 +0000 Subject: [PATCH] docs: clarify section authoring and Archify trust boundaries --- docs/contribution/diagrams.md | 4 ++-- docs/core/maintain.md | 11 ++++++++++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/contribution/diagrams.md b/docs/contribution/diagrams.md index 254e3dc..a9c6fd2 100644 --- a/docs/contribution/diagrams.md +++ b/docs/contribution/diagrams.md @@ -37,10 +37,10 @@ import ArchifyDiagram from '@site/src/components/ArchifyDiagram'; ``` -Supply a text alternative below each diagram. The wrapper uses a local, base-path-aware iframe with a descriptive title, scripts and downloads enabled, and no same-origin or parent-navigation permissions. A full-viewer link provides a wider canvas. Generated output is ignored by Git and rebuilt in CI. +Supply a text alternative below each diagram. The wrapper uses a local, base-path-aware iframe with a descriptive title, scripts and downloads enabled, and no same-origin or parent-navigation permissions. A full-viewer link provides a wider canvas in a new tab; that direct page is not iframe-sandboxed. Only publish reviewed, trusted diagrams, and do not describe iframe isolation as protection for the standalone route. Generated output is ignored by Git and rebuilt in CI. ## Integration boundaries -The portal remains Docusaurus/React/TypeScript with pnpm. It uses the actual upstream renderer, not a look-alike diagram implementation. No Astro site, global agent installation, hosted rendering service, or AI API was added. The integration disables Archify update networking and does not run its installation commands. +The portal remains Docusaurus/React/TypeScript with pnpm. It uses the actual upstream renderer, not a look-alike diagram implementation. No Astro site, global agent installation, hosted rendering service, or AI API was added. The integration disables Archify update networking and does not run its installation commands. This does not disable every possible build-time request: upstream can fetch authored, digest-pinned brand URLs. The current example contains none. Review external asset sources deliberately; update-check suppression is not an offline guarantee. Upgrades are deliberate: review the upstream diff and licenses, update the provenance record and vendor checksums, then run tests, diagram validation, production build, and browser checks. Do not edit upstream files for portal styling. diff --git a/docs/core/maintain.md b/docs/core/maintain.md index 945dfe7..042861c 100644 --- a/docs/core/maintain.md +++ b/docs/core/maintain.md @@ -19,7 +19,16 @@ Open the development server address printed in the terminal. The site uses the ` ## Add or change a page -Edit Markdown in `docs/`. Include `title` and `description` frontmatter and add the page ID to `sidebars.ts`. Keep the documentation’s future scope open until it is agreed. +Include `title` and `description` frontmatter. Place each page in its owning section and add its document ID to that section’s sidebar: + +| Section | Content directory | Sidebar configuration | +| --- | --- | --- | +| Organization | `docs/organization/` | `sidebars/organization.ts` | +| Strategy | `docs/strategy/` | `sidebars/strategy.ts` | +| Contribution | `docs/contribution/` | `sidebars/contribution.ts` | +| Portal maintenance and reference | `docs/core/` | `sidebars.ts` | + +Keep these content roots disjoint. Preserve existing URLs when moving pages. Specific AI initiatives and organizational reporting lines remain subject to agreement. ## Validate the change