Skip to content

📖 [Docs]: Issue guidance now follows the OKF structure - #91

Merged
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
docs-89-relocate-issue-guidance
Jul 25, 2026
Merged

📖 [Docs]: Issue guidance now follows the OKF structure#91
Marius Storhaug (MariusStorhaug) merged 1 commit into
mainfrom
docs-89-relocate-issue-guidance

Conversation

@MariusStorhaug

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

Copy link
Copy Markdown
Member

Issue guidance is now organized under the OKF Issues section, with dedicated Process and Types navigation so readers and agents can drill directly into format or hierarchy guidance.

Changed: Issue guidance follows the OKF structure

The existing Issue Format and Issue Hierarchy pages retain their established guidance at their new canonical locations. All repository navigation and references now resolve through the indexed Issues subtree, and the retired top-level paths no longer exist.

Technical Details

  • Added generated indexes for Issues, Issue Process, and Issue Types.
  • Relocated the two existing guidance pages without semantic expansion and adjusted only paths required by their new depth.
  • Updated Zensical navigation and every inbound repository link and anchor.
  • Implementation plan progress: all tasks in Relocate issue guidance into the OKF section #89 are complete; local validation, CI, and the explicit Copilot review round are clean.
Related issues

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 reorganizes issue-related guidance under the Ways-of-Working/Issues subtree (aligned to the OKF structure), adding section indexes and updating navigation and inbound links so readers (and agents) can jump directly to issue Process vs Types guidance.

Changes:

  • Updated Zensical navigation to introduce an Issues → Process / Types hierarchy with canonical paths.
  • Added generated index pages for Issues, Issue Process, and Issue Types.
  • Updated references across Ways of Working and Agents docs to point to the new canonical Issue Format and Issue Hierarchy locations.

Reviewed changes

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

Show a summary per file
File Description
src/zensical.toml Replaces top-level Issue Format/Hierarchy nav entries with an Issues subtree (Process/Types).
src/docs/Ways-of-Working/Workflow.md Updates Issue Format/Hierarchy links to new canonical locations.
src/docs/Ways-of-Working/Spec-Driven-Development.md Updates Issue Format/Hierarchy references to new canonical locations.
src/docs/Ways-of-Working/Issues/index.md Adds Issues section landing page with generated index table.
src/docs/Ways-of-Working/Issues/Process/index.md Adds Issue Process landing page with generated index table.
src/docs/Ways-of-Working/Issues/Process/Format.md Adjusts relative links after relocation; points hierarchy references to Types/Hierarchy.
src/docs/Ways-of-Working/Issues/Types/index.md Adds Issue Types landing page with generated index table.
src/docs/Ways-of-Working/Issues/Types/Hierarchy.md Adjusts relative links after relocation (e.g., Goal-Setting/Principles references).
src/docs/Ways-of-Working/index.md Replaces separate Issue Format/Hierarchy entries with a single Issues entry.
src/docs/Ways-of-Working/Goal-Setting.md Updates Issue Hierarchy link to new canonical location.
src/docs/Ways-of-Working/Fleet-Orchestration.md Updates Issue Format link to new canonical location.
src/docs/Ways-of-Working/Documentation-Model.md Updates Issue Format references to new canonical location.
src/docs/Ways-of-Working/Definition-of-Ready-and-Done.md Updates Issue Hierarchy link to new canonical location.
src/docs/Ways-of-Working/Contribution-Workflow.md Updates Issue Format link to new canonical location.
src/docs/Ways-of-Working/Branching-and-Merging.md Updates Issue Hierarchy link (including anchor) to new canonical location.
src/docs/Agents/implement.md Updates Issue Format link used by agent implementation guidance.
src/docs/Agents/define.md Updates Issue Format/Hierarchy links used by agent issue authoring guidance.

@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review July 25, 2026 20:11
@MariusStorhaug
Marius Storhaug (MariusStorhaug) merged commit 3e04c26 into main Jul 25, 2026
20 checks passed
@MariusStorhaug
Marius Storhaug (MariusStorhaug) deleted the docs-89-relocate-issue-guidance branch July 25, 2026 20:36
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.

Relocate issue guidance into the OKF section

2 participants