Approve MVP technical and acceptance plans
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
# Instructions for Labyricorn publishing content
|
||||
|
||||
These instructions apply to the entire `.labyricorn/` directory. More specific
|
||||
instructions in `project/AGENTS.md` and `devlog/AGENTS.md` also apply within
|
||||
those directories.
|
||||
|
||||
## Purpose and ownership
|
||||
|
||||
- This directory is the repository-owned source for the project's exhibition
|
||||
page and development log on Labyricorn.
|
||||
- This project repository is authoritative for the content. The Labyricorn site
|
||||
imports it as read-only content.
|
||||
- Read `.labyricorn/README.md` and the nearest scoped `AGENTS.md` before editing
|
||||
a publishing record.
|
||||
- Keep publishing changes focused. Do not alter application code merely to
|
||||
support an exhibition or devlog edit unless the user separately requests it.
|
||||
|
||||
## Authorization and content contract
|
||||
|
||||
- Preserve unrelated and uncommitted work. Never discard changes to obtain a
|
||||
clean working tree.
|
||||
- Do not commit or push unless the user explicitly requests publication.
|
||||
- Use native Lektor records named `contents.lr` and preserve `schema_version: 1`
|
||||
until a coordinated schema migration is approved.
|
||||
- Keep attachments inside the record subtree that owns them.
|
||||
- Use UTF-8 text, `YYYY-MM-DD` dates, and stable lowercase hyphenated slugs.
|
||||
- Do not add templates, models, plugins, workflows, executable files, builds,
|
||||
application state, credentials, raw HTML, scripts, or active third-party
|
||||
content below `.labyricorn/`.
|
||||
- Treat published URLs as durable. Ask before renaming or removing a published
|
||||
record; redirects or archival behavior may be required first.
|
||||
|
||||
## Security, synchronization, and review
|
||||
|
||||
- Never store or print passwords, API tokens, refresh credentials, private keys,
|
||||
`.netrc` contents, or other secrets in this directory.
|
||||
- Do not claim content is public merely because a push succeeded. Report push
|
||||
status and Labyricorn synchronization status separately.
|
||||
- Parse changed records, confirm referenced source commits exist, run
|
||||
`git diff --check`, and review the exact publishing diff before committing.
|
||||
- At handoff, report changed publishing records, validation performed, commit
|
||||
and push status, and synchronization status if known.
|
||||
@@ -6,6 +6,9 @@ This repository owns the public project page and development log for Twungeon.
|
||||
- `.labyricorn/devlog/contents.lr` is the development-log index.
|
||||
- Each directory below `.labyricorn/devlog/` is one chronological entry.
|
||||
|
||||
The project is currently in pre-development. The PRD and MVP definition are
|
||||
complete; future work should add dated devlog entries as the project moves
|
||||
through planning, implementation, testing, release, and maintenance.
|
||||
The project is currently in pre-implementation planning. The PRD and MVP
|
||||
definition are complete, the technical specification is approved, and a
|
||||
traceable acceptance-test/build checklist now defines the route into
|
||||
implementation. Runtime behavior and live Twitch integration are not yet
|
||||
claimed complete. Future work should add dated devlog entries as the project
|
||||
moves through implementation, testing, release, and maintenance.
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
# Instructions for the Labyricorn development log
|
||||
|
||||
These instructions apply to `.labyricorn/devlog/` and help coding assistants
|
||||
maintain the project's public development narrative safely.
|
||||
|
||||
## Format and ownership
|
||||
|
||||
- Keep the devlog index at `devlog/contents.lr` using `_model: devlog` and
|
||||
`schema_version: 1`.
|
||||
- Store each entry at `devlog/<stable-slug>/contents.lr` using
|
||||
`_model: devlog-entry` and `schema_version: 1`.
|
||||
- Use lowercase hyphenated entry slugs. Published slugs are durable public URLs;
|
||||
do not rename or delete them without explicit approval and a redirect or
|
||||
archival decision.
|
||||
- Every entry must contain `title`, `date`, `author`, `summary`, `tags`,
|
||||
`source_commit`, and Markdown `body` fields.
|
||||
- Keep entry attachments in that entry's directory. Only PNG, JPEG, and WebP
|
||||
images are accepted by the Labyricorn importer.
|
||||
- Do not add templates, models, plugins, executable code, builds, application
|
||||
state, credentials, or active third-party content below this directory.
|
||||
|
||||
## Content guidance
|
||||
|
||||
- Base entries on verifiable repository history, project documentation, and
|
||||
implemented behavior. Do not invent motivations, results, release status,
|
||||
user feedback, or completion claims.
|
||||
- Explain the milestone, why it mattered, and what changed. Keep one main
|
||||
milestone per entry and write a summary that works in a chronological list.
|
||||
Do not merely expand a commit message or enumerate every changed file.
|
||||
- Distinguish design and schema contracts from completed runtime behavior.
|
||||
- Link to the relevant canonical commit using the repository's HTTPS web URL.
|
||||
- Use the referenced commit's actual `YYYY-MM-DD` calendar date for retrospective
|
||||
entries, not the date on which the prose was drafted.
|
||||
- Set `source_commit` to the full lowercase 40-character commit ID most directly
|
||||
associated with the milestone. It must be an ancestor of the published branch.
|
||||
- Topics are comma-separated display labels. Unknown topics are allowed: the
|
||||
site keeps them visible but unlinked. Do not create or edit the site's tracked
|
||||
tag registry from this project repository.
|
||||
- Use Markdown without raw HTML, scripts, embedded credentials, or active
|
||||
external content.
|
||||
- Multiple entries may share a date. The site resolves ties from source history;
|
||||
do not invent timestamps or manual next/previous links.
|
||||
- Do not rewrite older entries merely because the implementation later changed.
|
||||
Add a new entry or a clearly labelled correction when historical context is
|
||||
needed.
|
||||
|
||||
## Safety and review
|
||||
|
||||
- Preserve unrelated project files and uncommitted work. The devlog owns only
|
||||
`.labyricorn/devlog/`.
|
||||
- Do not commit or push unless the user explicitly requests publication.
|
||||
- Before publication, verify claims against the referenced commit, validate all
|
||||
records, check that the source-commit link uses the same full commit ID, review
|
||||
the exact devlog diff, and confirm unrelated files are not staged in the
|
||||
publishing commit.
|
||||
- Prefer the repository-root `devlog_editor.py` for routine validation and safe
|
||||
publication when it is available.
|
||||
@@ -51,3 +51,6 @@ This entry marks the end of product definition, not the beginning of
|
||||
implementation. Future devlog entries will record technical planning, build
|
||||
phases, validation evidence, scope changes, and what is learned from real
|
||||
viewers.
|
||||
|
||||
The canonical source for this product-definition milestone is
|
||||
[commit `d67d9fc5230985895de9dd8232525ea8ca474e05`](https://git.labyricorn.com/Labyricorn/Twungeon/commit/d67d9fc5230985895de9dd8232525ea8ca474e05).
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
# Instructions for the Labyricorn project record
|
||||
|
||||
These instructions supplement `.labyricorn/AGENTS.md` and apply to the
|
||||
`project/` directory.
|
||||
|
||||
## Record structure
|
||||
|
||||
- Maintain exactly one project record at `project/contents.lr` using
|
||||
`_model: project` and `schema_version: 1`.
|
||||
- Keep `project_id` stable. It is the durable identity used by the importer and
|
||||
public URL.
|
||||
- Ask before changing the repository URL, default branch, project status,
|
||||
author, start date, or project identity.
|
||||
- Store project-owned images in this directory and reference them by filename
|
||||
from `contents.lr`. Only PNG, JPEG, and WebP images are accepted.
|
||||
|
||||
## Editorial guidance
|
||||
|
||||
- Write the exhibition page as a concise project narrative, not as a copy of
|
||||
the repository README or as release documentation.
|
||||
- Verify technical and status claims against the repository before editing.
|
||||
- Distinguish completed work, formal design work, experiments, and future work.
|
||||
- Do not manually add repository-derived commit, license, language, release,
|
||||
issue, star, or fork metadata. The Labyricorn importer owns those values.
|
||||
- Keep the summary suitable for listings and social previews.
|
||||
|
||||
## Review requirements
|
||||
|
||||
- Confirm all required project fields are present and any image reference stays
|
||||
inside `project/`.
|
||||
- Check Markdown links are intentional HTTPS links and prose makes no unsupported
|
||||
claims.
|
||||
- Validate the record and run `git diff --check` before committing.
|
||||
@@ -18,7 +18,7 @@ repository_url: https://git.labyricorn.com/Labyricorn/Twungeon
|
||||
---
|
||||
default_branch: main
|
||||
---
|
||||
tags: Twitch, Twitch Extension, RPGJS, Twurple, TypeScript, game design, pre-development, PRD, MVP, planning, architecture, documentation
|
||||
tags: Twitch, Twitch Extension, RPGJS, Twurple, TypeScript, game design, pre-development, PRD, MVP, planning, architecture, acceptance testing, documentation
|
||||
---
|
||||
body:
|
||||
|
||||
@@ -45,8 +45,15 @@ Twurple for Twitch integration, and a Twitch Extension for player controls.
|
||||
The design keeps Twungeon's game rules separate from RPGJS where practical so
|
||||
the prototype can be replaced without discarding the validated concept.
|
||||
|
||||
The current source of truth is the
|
||||
The product source of truth is the
|
||||
[Twungeon MVP Product Requirements Document](https://git.labyricorn.com/Labyricorn/Twungeon/blob/main/Twungeon_MVP_PRD_Current.md).
|
||||
The project is in pre-development: the PRD and MVP definition are complete,
|
||||
and this repository will document the transition through technical planning,
|
||||
implementation, testing, release preparation, and maintenance.
|
||||
The approved
|
||||
[technical specification](https://git.labyricorn.com/Labyricorn/Twungeon/blob/main/Twungeon_MVP_Technical_Specification.md)
|
||||
defines the authoritative architecture and game behavior. The
|
||||
[acceptance-test and build checklist](https://git.labyricorn.com/Labyricorn/Twungeon/blob/main/Twungeon_MVP_Acceptance_Test_and_Build_Checklist.md)
|
||||
sequences implementation and maps evidence to all 33 MVP success criteria.
|
||||
|
||||
The project remains in pre-implementation planning. These documents establish
|
||||
the build baseline, but they do not claim that runtime behavior, Twitch
|
||||
integration, or viewer validation is complete. Future records will document
|
||||
implementation, testing, release preparation, and maintenance as they occur.
|
||||
|
||||
Reference in New Issue
Block a user