kindred/create
1
1
Fork 0
Code Issues 53 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

docs: split REPOSITORY_STATE.md into topic files #18

Merged
forbes merged 1 commits from docs/split-repository-state into main 2026-02-06 17:22:44 +00:00
Conversation 0 Commits 1 Files Changed 5 +275 -215
forbes commented 2026-02-06 17:19:49 +00:00
Owner
Copy Link

Summary

Split the monolithic docs/REPOSITORY_STATE.md into four focused topic files for easier navigation and independent updates.

Changes

Deleted:

  • docs/REPOSITORY_STATE.md (215 lines) -- replaced entirely by the four files below

Created:

  • docs/OVERVIEW.md -- lightweight index with metadata, submodule table, and doc links
  • docs/ARCHITECTURE.md -- bootstrap flow diagram and source layout tree
  • docs/COMPONENTS.md -- ztools (9 commands), Origin commands (5 C++), Silo workbench (14 commands), theme, icon infrastructure
  • docs/KNOWN_ISSUES.md -- bugs, incomplete features, and next steps

Content updates (vs old REPOSITORY_STATE.md)

These docs were stale as of 0ef9ffcf51 (2026-02-03). Updated to reflect HEAD at c858706d480:

  • Silo commands: 13 -> 14 (added Silo_Auth)
  • Authentication status: was "not implemented", now correctly documented as "local auth complete, LDAP/OIDC coded but pending infrastructure"
  • CSRF protection: was "not implemented", now "implemented (nosurf library)"
  • OndselSolver pin: e32c9cd -> 5d1988b
  • Silo submodule pin: 17a10ab -> 27e112e
  • Added Known Issues #11: missing silo icons (silo-tag, silo-rollback, silo-status)
  • Added Known Issues #12: OndselSolver Newton-Raphson convergence fix (retained for reference)
  • Added Known Issues #13: Assembly solver crash on document restore fix (retained for reference)
  • Architecture: added Origin abstraction files (FileOrigin, CommandOrigin, OriginManager, OriginSelectorWidget)
  • Icon infrastructure: fully documented Qt resource icons vs runtime module icons

Motivation

A single monolithic doc was hard to navigate and update. Topic files let each area be updated independently without merge conflicts, and the index in OVERVIEW.md provides a clear entry point.

No code changes.

## Summary Split the monolithic `docs/REPOSITORY_STATE.md` into four focused topic files for easier navigation and independent updates. ## Changes **Deleted:** - `docs/REPOSITORY_STATE.md` (215 lines) -- replaced entirely by the four files below **Created:** - `docs/OVERVIEW.md` -- lightweight index with metadata, submodule table, and doc links - `docs/ARCHITECTURE.md` -- bootstrap flow diagram and source layout tree - `docs/COMPONENTS.md` -- ztools (9 commands), Origin commands (5 C++), Silo workbench (14 commands), theme, icon infrastructure - `docs/KNOWN_ISSUES.md` -- bugs, incomplete features, and next steps ## Content updates (vs old REPOSITORY_STATE.md) These docs were stale as of `0ef9ffcf51` (2026-02-03). Updated to reflect HEAD at `c858706d480`: - **Silo commands**: 13 -> 14 (added `Silo_Auth`) - **Authentication status**: was "not implemented", now correctly documented as "local auth complete, LDAP/OIDC coded but pending infrastructure" - **CSRF protection**: was "not implemented", now "implemented (nosurf library)" - **OndselSolver pin**: `e32c9cd` -> `5d1988b` - **Silo submodule pin**: `17a10ab` -> `27e112e` - **Added Known Issues #11**: missing silo icons (silo-tag, silo-rollback, silo-status) - **Added Known Issues #12**: OndselSolver Newton-Raphson convergence fix (retained for reference) - **Added Known Issues #13**: Assembly solver crash on document restore fix (retained for reference) - **Architecture**: added Origin abstraction files (FileOrigin, CommandOrigin, OriginManager, OriginSelectorWidget) - **Icon infrastructure**: fully documented Qt resource icons vs runtime module icons ## Motivation A single monolithic doc was hard to navigate and update. Topic files let each area be updated independently without merge conflicts, and the index in OVERVIEW.md provides a clear entry point. No code changes.
forbes added 1 commit 2026-02-06 17:19:49 +00:00
docs: split REPOSITORY_STATE.md into topic files
Some checks failed
Build and Test / build (pull_request) Has been cancelled
Details
a2200b4042 
Replace the monolithic REPOSITORY_STATE.md with four focused files:

- OVERVIEW.md: metadata, submodule pins, doc index
- ARCHITECTURE.md: bootstrap flow, source layout
- COMPONENTS.md: ztools, Silo, Origin commands, theme, icons
- KNOWN_ISSUES.md: bugs, incomplete features, next steps

Updates reflected in the split:
- Silo auth: corrected from 'not implemented' to 'local auth
  complete; LDAP/OIDC pending infrastructure'
- CSRF: corrected from 'not implemented' to 'implemented (nosurf)'
- Silo commands: 14 (was 13, added Silo_Auth)
- New Origin commands section (5 C++ commands)
- New icon infrastructure section with missing icon tracking
- New issues: Newton-Raphson convergence fix (#12), Assembly
  restore crash fix (#13), missing Silo icons (#11)
- Updated submodule pins (silo 27e112e, OndselSolver 5d1988b)
forbes merged commit 5db68dab25 into main 2026-02-06 17:22:44 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
UX
branding
bug
ci/cd
CI/CD workflows and deployment
 defaults
documentation
Developer documentation
 enhancement
high-priority
low-priority
theme
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
forbes
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: kindred/create#18
Delete Branch "docs/split-repository-state"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?