Repository navigation
design: start the design foundation and orient every session through the graph - #42
Draft
darko-mijic wants to merge 1 commit into
Draft
darko-mijic wants to merge 1 commit into
darko-mijic wants to merge 1 commit into
Conversation
…the graph Opens the design arc for the Protocol's human readings (UX and information architecture of role- and work-specific Studio views), stacked on the article refresh. This is the first of many iterations. Owner's working rules for the arc: - Design sessions record what they find for engineering sessions; they never edit carriers, Packs, anchors or anything else that feeds the graph. - The graph first: load the reading skill, ask the graph through sdp:q, and read a carrier last, only for its exact wording. Specify part of every piece of work as graph queries, not only prose. - Keep personas and the niche, specialised, ultra-specialised and AI-powered options on the table; traditional delivery roles are the first cycles' focus, not the limit. - The core stays open source and free; a commercial Studio (desktop, web, CI/CD) is exploratory. - No visual style until the existing UI library and design system arrive. - Corpus counts are derived, never quoted. Design questions are answered over months of iterations; technical questions are answered from the repository. Base: 5380443 (docs/articles-refresh-1). Arc's Pack: none. By the owner's rule the design material stays outside the corpus; a corpus home for it is recorded as a proposal for an engineering session (docs/design/07-graph-needs.md). What lands: - PRODUCT.md: the product record for design work (users, purpose, positioning, constraints, principles). - docs/design/: README and documents 01-12 (roles and personas, the seed design's experience mapped to now, reading material, reading model and IA, specialised and AI readings, design cycles, graph needs with reader frictions and on-ramp observations, what the repository settles, design method, a Studio baseline, RUP roles and artifacts as projections, analogous products). - AGENTS.md: "Orient before work" replaces the owner's TODO, pointing to eleven mandatory sdp:q queries; also the owner's reformatting of the "Where to look" table. - .agents/skills/sdp-agent-surface/orientation.md: the eleven queries with reading notes, behind a one-line pointer in SKILL.md (checkout only; not in the package's files list). Evidence: every orientation query ran from the committed file with exit 0 (each also ran twice with byte-identical output); the design documents' factual claims were checked against the graph; npm run check is green for this tree in a clean worktree with the new files staged. In the main checkout the check-clean steps failed only on macOS Finder .DS_Store files inside an open generated/ folder (recorded in docs/design/07-graph-needs.md). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
This branch has not been deployed
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.
What this opens
This pull request opens the design work for the Protocol's human readings. The aim is the UX and information architecture of Studio views for particular delivery roles and kinds of work, built on one premise. All delivery state lives in one graph, so every view is a projection: free to regenerate, never a second store. That lets the product serve many readers without limiting itself to today's pages.
It is the first of many iterations, stacked on #41 (the article refresh that prepared this pass). It deliberately sets no visual style, because an existing UI library and design system will be introduced later. What lands is the foundation:
PRODUCT.md);docs/design/;AGENTS.md.The session also produced something the owner expected: a large set of engineering improvements. When research agents explored this self-hosted repository, they mostly searched and read files instead of asking the graph, even though the handbook makes the graph mandatory. Mining their transcripts measured that gap and turned it into a ranked list of what the graph should answer up front. That list became the orientation queries. The frictions became considerations for the next engineering session.
A tour
Links are pinned to
760a88c5.PRODUCT.mddocs/design/README.md· 09 Design methodAGENTS.md·orientation.mdWhat the research found
These are measurements of this session's research, not of the corpus. Over the 31 research-agent transcripts, agents made about 1,200 search and file-read calls, which returned about 5.9M characters, and 194
sdp:qcalls, which returned about 0.38M. About 480 of the file calls (about 2.35M characters) read Spec carriers the graph already holds. The needs behind them ranked as follows:Re-asked as shaped queries, each took one call and a fraction of the text. The eleven orientation queries answer these needs before work starts and show the correct answer paths in working bodies.
07 also records, each reproduced with a query:
sdp validateremoves the page roots; the green gate reads macOS.DS_Storefiles as projection drift.Rulings
Rulings the owner made:
PRODUCT.mdPRODUCT.mdPRODUCT.md, 04PRODUCT.mdAGENTS.md,orientation.mdsdp:qas a complement to an agent's own toolsRulings delegated to the agent, awaiting the owner's review:
package.jsonlists eachSKILL.mdonly; shipping an adopter-neutral form is left to engineeringNo registry row is added;
docs/concept/DECISIONS.mdis unchanged.What no human view shows yet
No projection changes in this pull request. The Studio, Design Review, census, Mermaid, Gherkin and the vault render exactly as at the base. The design foundation is Markdown for now; the first readings it proposes reach prototypes in later iterations.
Try it
From a checkout of
design/foundation-1:At the head, all eleven exit 0 and print about 21K characters in total.
Feedback wanted
The next work, from the roadmap
Roadmap: The Protocol's roadmap
pack:roadmapTo state means the floor allows ready and a person still judges the statement. Built means every Spec of the entry's work states ready and has an implementation binding; it reports no passing test and no deployment.
The Protocol's next work, first entry first. The order is a preference: it dates, gates and sequences nothing, and what each entry still needs is read from the graph each time.
First the cleanup that removes the frozen plans, review reports and superseded concept material, as the roadmap and the pull request record make possible. Then the two steps a reader of the Studio's pages could not take, the words of a test line that checks a declaration and an outside register's entries, and then the composed-intent model the build backlog holds. What the first adopter's mass update asks for joins when the owner selects it; a capture landing adds nothing here. An entry leaves by an edit to this manifest once its selected work is complete or no longer belongs among the next work.
To design
spec:protocol.delivery-record-cleanupidea→scoped, nothing holds it; blocked byspec:protocol.delivery-record-cleanup#question.durableContentplans/,reviews/and the superseded concept material from the tree, after moving into the graph the durable content they still hold, so the repository keeps one delivery record: the graph, git and the pull requests.spec:consumers.spec-studio.register-inputscoped→defined, held by no-blocking-open-questions; blocked byspec:consumers.spec-studio.register-input#question.registerEntry,spec:consumers.spec-studio.register-input#question.inputFormTo state
spec:consumers.spec-studio.cited-line-textTo build
spec:consumers.edit-modelWaiting on the owner
spec:protocol.delivery-record-cleanup#question.durableContent(blocking), place 1: Which content inplans/,reviews/and the concept documents does no Spec, test, decision or recipe carry yet, and where does each piece belong?spec:consumers.spec-studio.cited-line-text: it statesscopedand its floor allowsready; place 2spec:protocol.delivery-record-cleanup: it statesideaand its floor allowsscoped; place 1Deferred, with their triggers
spec:carrier.sdp-import.feature-adapter#question.featureAdapter: Which bare .feature constructs can an import adapter preserve honestly? Trigger: an adopter migrates a gen-1.featurecorpus into the Protocolspec:consumers.agent-surface.combination-coverage#question.combinationCoverage: Which combinations of slot values should coverage enumerate and report? Trigger: a design pass asks which combinations no example exercisesspec:consumers.ai-assisted-reading#question.aiPresentationBoundary: If an assistant generates explanations or arrangements beyond selecting deterministic readings, what contract keeps its output distinct from graph claims and makes the exact reading reviewable, including how the exact output is retained with its model, prompt and inputs? Trigger: the UX design pass measures that assistant selection or a generated explanation helps a named review taskspec:consumers.impact-graph.symbol-reach#question.symbolIdentity: Which language-neutral identity and extraction boundary can support exhaustive symbol reach without freezing a single compiler's representation into the Protocol? Trigger: a reader needs symbol-level reach that file-level imports and curated anchors cannot givespec:consumers.projections-model.roadmap-views#question.releaseReader: Does a reader need release or baseline views that the roadmap, the recipes and git tags do not serve? Trigger: the first published releasespec:consumers.reference-projection#question.namedOutsideReader: Does a human reader outside the repository need a reference projection the four shipped roots do not serve? The taxonomy row is not that reader. Trigger: a named consumer outside the repository, with a way to measure that demand inside the arc that builds the projectionspec:consumers.structural-mermaid#question.namedStructuralReader: Does a reader need diagrams rooted at code units, which census tables and Spec-rooted one-hop Mermaid do not serve? Trigger: a named reader with that need, plus a decision that refinesspec:decisions.shipped-projections-frozenfor the affected Mermaid rendering or supersedes that ruling wholespec:observation.run-evidence.bound-file-freshness#question.freshness: When should changes to bound files make recorded run evidence stale? Trigger: a reader cannot tell whether a run at another commit still applies, because nothing says whether its bound files changed sincespec:observation.runtime-overlay#question.observationIdentity: Which external observation identity and freshness boundary is small enough for the graph while still supporting an honestobserveddelivery fact? Trigger: An adopter needs runtime measurements linked to measurable Spec targets and can supply an observation identity and freshness policy for review.This pull request adds no roadmap entry; entries join or move only on the owner's word. The owner's direction for the very next session sits outside the roadmap: fix the skills (progressive disclosure), better promote
sdp:q, and start working through the hand-off in 07.Record
docs/articles-refresh-1(docs(articles): re-pin the series to f990bded for the first design pass #41), at53804437. GitHub retargets this pull request when docs(articles): re-pin the series to f990bded for the first design pass #41 merges.npm run checkis green for this tree in a clean worktree, with the new files staged. In the main checkout, the check-clean steps failed only on macOS Finder.DS_Storefiles inside an opengenerated/folder (logged in 07).🤖 Generated with Claude Code