Skip to content

📖 [Docs]: Issue planning, types, and relationships are defined#94

Merged
Marius Storhaug (MariusStorhaug) merged 13 commits into
mainfrom
docs-88-issue-process
Jul 26, 2026
Merged

📖 [Docs]: Issue planning, types, and relationships are defined#94
Marius Storhaug (MariusStorhaug) merged 13 commits into
mainfrom
docs-88-issue-process

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 25, 2026

Copy link
Copy Markdown
Member

Issue guidance now explains how bodies, types, readiness, and native relationships evolve from capture through operation while keeping the Workflow page authoritative for phase definitions.

New: Issue lifecycle, planning, and relationships

The Process section now maps issue evolution onto the shared workflow, explains progressive Why/How/What decomposition, and establishes GitHub sub-issues and dependency edges as the authoritative containment and execution-order model. Ready siblings without dependency edges can proceed in parallel.

New: Native issue type guidance

Dedicated Epic, PBI, Task, and Bug pages now define the body detail, readiness, planning altitude, and completion rules for each native type. The shared hierarchy page focuses on taxonomy, routing, containment, and promotion or demotion.

Changed: Universal issue format

Issue Format now contains only rules shared by every native type and routes readers to the type-specific guidance. Manual relationship fields, copied child lists, and list-order sequencing are explicitly rejected.


Technical details
Relevant issues (or links)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR expands the “Issues → Process” documentation to define how issues evolve through the workflow, how planning detail is added progressively, and how GitHub-native relationships define containment and execution order—while simplifying the “Format” page down to universal rules.

Changes:

  • Added new Process pages for lifecycle, planning, and relationship guidance.
  • Refactored “Issue Format” to only include rules shared by all issue types and defer type-specific detail elsewhere.
  • Updated site navigation and the Process index to include the new pages.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/zensical.toml Adds the new Process pages to the Zensical nav tree.
src/docs/Ways-of-Working/Issues/Process/Relationships.md Defines native containment/dependency semantics and rejects manual relationship duplication.
src/docs/Ways-of-Working/Issues/Process/Planning.md Introduces “planning altitudes” and progressive Why/How/What decomposition guidance.
src/docs/Ways-of-Working/Issues/Process/Lifecycle.md Maps how issues’ bodies/types/relationships evolve across workflow phases.
src/docs/Ways-of-Working/Issues/Process/index.md Updates the Process index entries to include the new pages.
src/docs/Ways-of-Working/Issues/Process/Format.md Replaces the prior detailed format spec with universal rules and cross-links to the new guidance.

Comment thread src/docs/Ways-of-Working/Issues/Process/Format.md
Comment thread src/docs/Ways-of-Working/Issues/Process/Planning.md
Comment thread src/docs/Ways-of-Working/Issues/Process/Relationships.md
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Comment thread src/zensical.toml

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Comment thread src/docs/Ways-of-Working/Issues/Types/Hierarchy.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

src/docs/Ways-of-Working/Issues/Types/PBI.md:25

  • “nested-PBI” is hyphenated here but elsewhere the docs use “nested PBI(s)”. Keeping it unhyphenated avoids inconsistent terminology.
- Explain the decomposition into Task, Bug, or nested-PBI children.

Comment thread src/docs/Ways-of-Working/Issues/Process/index.md
Comment thread src/docs/Ways-of-Working/Issues/Types/index.md Outdated
Comment thread src/docs/Ways-of-Working/Issues/Types/Hierarchy.md Outdated
Comment thread src/docs/Ways-of-Working/Issues/Types/PBI.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

@MariusStorhaug

Copy link
Copy Markdown
Member Author

Generated-index note: Process/index.md now has an accurate section description. Update-DocumentationIndex.ps1 propagates that frontmatter into the parent Issues/index.md row, so both one-line changes travel together in 2c3d91b. The parent-row update is generated Process integration, not broader authored scope.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 26, 2026 00:00
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit f156c36 into main Jul 26, 2026
20 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs-88-issue-process branch July 26, 2026 00:00
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title 📖 [Docs]: Issue planning and relationships are defined 📖 [Docs]: Issue planning, types, and relationships are defined Jul 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Describe issue phases, planning, and relationships Define Epic, PBI, Task, and Bug issue bodies

2 participants