Skip to content

Add dedicated page to the different options of "definition" of the capacity spec - #33

Open
polmauri wants to merge 2 commits into
mainfrom
pr33
Open

Add dedicated page to the different options of "definition" of the capacity spec#33
polmauri wants to merge 2 commits into
mainfrom
pr33

Conversation

@polmauri

@polmauri polmauri commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

polmauri added 2 commits June 23, 2026 16:35
Replaces the placeholder Core Concepts content with the canonical
"Modeling Constructs" material from the wiki, restructured to serve as the
single Core Concepts overview page.

- Rewrote `docs/core-concepts/overview.md` with the wiki content, organized
  into: Assignment Problem, Dimensions (incl. Dynamic Dimensions), Scopes,
  Partitions, Goals and Constraints, and Example.
- Authored a new "Goals and Constraints" section from scratch, explaining how
  specs (capacity, balance, diversity, minimize movement, ...) reference the
  previously defined dimensions/scopes/partitions and act as either a goal or
  a constraint. Links to the Goals & Constraints reference.
- Added the 5 source diagrams under `static/img/core-concepts/` and referenced
  them via Docusaurus's `pathname://` escape hatch (see Notes).
- Removed the obsolete sub-pages now folded into the overview:
  `dimensions.md`, `scopes-and-partitions.md`, `groups.md`,
  `goals-vs-constraints.md`, `objects-and-containers.md`.
- Rewrote the internal wiki link to the local Avoid Assignments reference.
- Repointed 12 inbound links across 10 docs to the consolidated overview
  (with section anchors) so no links break.
- Copy polish: grammar/spelling fixes, accessible image alt text, consistent
  CPU casing, backticked identifiers (`prohibitedObjects`, `rack`, ...).

Docusaurus 3.9 converts local markdown images into webpack `require()` calls
through `url-loader`, which crashes in this repo because the `ajv` override
(`>=6.14.0`) pulls `ajv@8` into `ajv-keywords@3` (which needs `ajv@6`). The
`pathname://` prefix serves the images as static assets and bypasses the
broken loader without touching the dependency tree.

- `yarn build` succeeds with no errors and no broken-link warnings.
- `yarn start` → `/docs/core-concepts` renders all five diagrams and all
  section anchors resolve.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant