Skip to content

docs: reorganize playbook navigation into role-based sections - #1134

Open
vdstrizhkova wants to merge 4 commits into
microsoft:mainfrom
vdstrizhkova:feat/docs-restructure
Open

docs: reorganize playbook navigation into role-based sections#1134
vdstrizhkova wants to merge 4 commits into
microsoft:mainfrom
vdstrizhkova:feat/docs-restructure

Conversation

@vdstrizhkova

@vdstrizhkova vdstrizhkova commented Jul 16, 2026

Copy link
Copy Markdown

Pull Request Template

What are you trying to address

This is part 2 of 3 splitting PR #1130. It is purely a reorganization of the playbook's information architecture - it adds no new guidance content (the AI/HVE additions live in #1133).

Scope: 12 files changed (+249 / -82) relative to its base.

Reorganization

  • New "Start Here" section with role-based on-ramps: docs/start-here/README.md, for-engineers.md, for-data-scientists.md, for-leads.md, project-kickoff-checklist.md, and .pages.
  • New Non-Functional Requirements section (docs/non-functional-requirements/README.md) consolidating NFR content into its own area.
  • Navigation updates across docs/.pages, README.md, and docs/README.md.
  • Renamed docs/design/readme.md -> docs/design/README.md for consistency.
  • Removed docs/the-first-week-of-an-ise-project.md (superseded by the Start Here section).

Stacking: this branch is stacked on #1133. Until #1133 merges, this PR's diff also shows those changes; it reduces to reorganization-only once #1133 lands (or after a rebase onto main).

Breaking change: the first-week page was removed; external links to the old path should redirect to the Start Here section.

Checklist

READY TO PR? Use the check-list below to ensure your branch is ready for PR.

  • Changes follow the repo structure and land in the appropriate folder and section
  • No confidential information
  • No duplicated content
  • Labeled appropriately
  • This PR was reviewed by at least one subject matter expert
  • No lint check errors related to your changes

Varvara Strizhkova added 2 commits July 16, 2026 09:16
- align wording and tone across observability, security, code-review, and other docs
- fix outdated/broken external links and dead references
- add cspell terms, gitignore/gitattributes, and mkdocs workflow action bumps

📝 - Generated by Copilot
- lychee surfaces a backlog of pre-existing broken/blocked external links
- keep it disabled (as in the source PR) until that backlog is triaged

🔧 - Generated by Copilot
@vdstrizhkova
vdstrizhkova force-pushed the feat/docs-restructure branch from d647880 to f8ac167 Compare July 16, 2026 13:25
Varvara Strizhkova added 2 commits July 16, 2026 16:46
- add AI-assisted engineering hub (docs/ai-assisted-engineering/README.md)
- add generative-AI and agentic systems guidance, including HVE references

🤖 - Generated by Copilot
- add Start Here section with role on-ramps and project kickoff checklist
- add Non-Functional Requirements section and update navigation (.pages, READMEs)
- rename docs/design/readme.md to README.md; remove superseded first-week page

🗂️ - Generated by Copilot
@vdstrizhkova
vdstrizhkova force-pushed the feat/docs-restructure branch from f8ac167 to 3d5c568 Compare July 16, 2026 16:48
@vdstrizhkova vdstrizhkova changed the title docs: restructure playbook and add role-based guidance pages docs: reorganize playbook navigation into role-based sections Jul 16, 2026
@vdstrizhkova
vdstrizhkova marked this pull request as ready for review July 16, 2026 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant