Revise the Seriatim plan and workspace conventions
This commit is contained in:
44
docs/orientation.md
Normal file
44
docs/orientation.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Workspace Orientation
|
||||
|
||||
## Repository Map
|
||||
|
||||
Repositories inside this directory:
|
||||
|
||||
- `ansible-collection-dnd`: the `rakestraw.dnd` collection that bundles and
|
||||
distributes the pipeline suite.
|
||||
- `ansible-role-dnd-pipeline`: independent source repository for the
|
||||
suite-level role exposed by the collection as `rakestraw.dnd.pipeline`.
|
||||
- `ansible-role-{narratio,notarius,audita,seriatim,scriptorium}`: standalone
|
||||
application roles.
|
||||
- `rakestraw-ansible`: working deployment repository containing the
|
||||
`pipeline_dnd` proof of concept; treat it as read-only reference unless the
|
||||
task explicitly includes it.
|
||||
|
||||
Relevant upstream repositories are siblings of this directory:
|
||||
|
||||
- `../{narratio,notarius,audita,seriatim,scriptorium}`: application source and
|
||||
authoritative application contracts.
|
||||
- `../narratio-prompts`: pipeline prompt-library content.
|
||||
|
||||
Use [the workspace inventory](../workspace.yml) as the complete
|
||||
machine-readable inventory of paths and remotes.
|
||||
|
||||
## Sources of Truth
|
||||
|
||||
- [Workspace conventions](conventions.md): normative working and Ansible house
|
||||
style.
|
||||
- [Planning policy](planning.md): normative feature planning and progress
|
||||
workflow.
|
||||
- [MVP roadmap](roadmap/mvp.md): settled MVP scope, architecture, and open
|
||||
design work.
|
||||
- [Feature roadmaps](roadmap/features/): durable scope and target state for
|
||||
selected units of work.
|
||||
- [Workspace status](status.md): current cross-repository progress and next
|
||||
work.
|
||||
- [Decision records](decisions/): durable rationale for significant
|
||||
architectural choices.
|
||||
- [Implementation plan](roadmap/implementation.md): the fixed location for the
|
||||
active staged plan or, when no plan is approved, a pending-plan notice.
|
||||
- Application repositories: CLI, configuration, build, and integration
|
||||
contracts.
|
||||
- Individual Ansible repositories: implementation and repository-local tests.
|
||||
Reference in New Issue
Block a user