docs: clarify artifact lifecycle stages - #31
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR closes the artifact lifecycle documentation gap by making lifecycle stages explicit across the builder.
It adds controlled lifecycle-stage documentation, updates catalog metadata, shows lifecycle stage information in the learning panel, and adds runtime public-safety guidance for runtime artifacts.
Issue addressed
Closes #4
Changes
Adds
docs/artifact-lifecycle.mdDefines the controlled lifecycle stages:
design-timeruntimeiterationUpdates
src/data/artifactCatalog.jsso all artifacts use the controlled lifecycle vocabularyRemaps prior
build-timeartifacts todesign-timeRemaps
eval-rubrictoiterationAdds runtime public-safety guidance to runtime artifacts
Updates the learning panel to show:
Updates related docs:
Updates tests to enforce lifecycle metadata and runtime safety guidance
Boundary decisions
Validation
git status --short --branchgit diff --checknode --check src/app.jsnode --check src/renderers/markdownRenderer.jsnode --check src/renderers/artifactRenderers.jsnode --check src/renderers/rendererUtils.jsnode --check src/examples/exampleValues.jsnode --check src/data/artifactCatalog.jsnode tests/catalogIntegrity.test.mjsnode tests/rendererSmoke.test.mjsStatic server returned HTTP 200 for:
/app.jsdata/artifactCatalog.jsKnown limitations
Browser click-through validation was not completed because the in-app browser target was unavailable in the Codex session.
The temporary local server was stopped.