docs: move README guidance to the official documentation website - #1406
Open
Wassim Chegham (manekinekko) wants to merge 4 commits into
Open
Wassim Chegham (manekinekko) wants to merge 4 commits into
Wassim Chegham (manekinekko) wants to merge 4 commits into
Conversation
Keep the README focused on introducing Scope and directing users and contributors to the official documentation. Move setup, development, contribution, support, and licensing details into navigable website pages. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Wassim Chegham (manekinekko)
added
the
documentation
Wassim Chegham (manekinekko)
marked this pull request as ready for review
September 18, 2026 07:51
Wassim Chegham (manekinekko)
requested review from
Cedric Vidal (cedricvidal)
and
a balanced review from Copilot
September 18, 2026 07:51
Copilot started reviewing on behalf of
Wassim Chegham (manekinekko)
September 18, 2026 07:52
View session
There was a problem hiding this comment.
🟡 Changes recommended
Several promoted documentation paths retain obsolete repository references, and the first-run landing description is inaccurate.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Moves detailed README guidance into the official documentation website.
Changes:
- Adds local development, contributor, development, support, and security guides.
- Expands platform concepts and evaluation guidance.
- Updates navigation and repository entry points.
File summaries
| File | Description |
|---|---|
README.md |
Replaces detailed guidance with website links. |
CONTRIBUTING.md |
Updates documentation contribution guidance. |
website/README.md |
Documents the website’s new role. |
website/astro.config.mjs |
Registers new sidebar pages. |
website/src/content/docs/index.mdx |
Adds setup and contribution cards. |
website/src/content/docs/getting-started/access.md |
Links local setup guidance. |
website/src/content/docs/getting-started/first-run.md |
Updates first-run prerequisites. |
website/src/content/docs/getting-started/local-development.md |
Adds comprehensive local setup instructions. |
website/src/content/docs/introduction/concepts.md |
Adds evaluation building blocks. |
website/src/content/docs/introduction/what-is-scope.md |
Expands architecture and interpretation guidance. |
website/src/content/docs/resources/contributing.md |
Adds contribution and licensing guidance. |
website/src/content/docs/resources/development.md |
Adds repository and development references. |
website/src/content/docs/resources/support.md |
Adds support, security, and responsible-use guidance. |
Review details
- Files reviewed: 13/13 changed files
- Comments generated: 3
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Copilot started reviewing on behalf of
Wassim Chegham (manekinekko)
September 18, 2026 08:16
View session
Align installation docs, release discovery, self-update downloads, and the publisher with the current repository. Build shared dependencies before publishing and cover installer transports and release lookups with regression tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Test Results (Node.js 22)test: Run #70
🎉 All tests passed! |
Use this microsoft/scope checkout as the documentation source of truth. Verify source-map links and clarify website, OpenAPI, and Pages workflow paths. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Test Results (Node.js 22)test: Run #71
🎉 All tests passed! |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Test Results (Node.js 22)test: Run #72
🎉 All tests passed! |
Josh Duffney (duffney)
requested review from
Josh Duffney (duffney)
and removed request for
Cedric Vidal (cedricvidal)
September 21, 2026 17:22
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.
Summary
Demo
N/A: documentation-only changes; no Portal or CLI behavior changes.
Testing
cd website && pnpm test: all 7 plugin tests passed.cd website && SITE=https://microsoft.github.io BASE_PATH=/scope pnpm run build: passed with the public GitHub Pages base path.git diff --check: passed.Documentation and compatibility
New website pages:
These pages will be published when the website deployment includes this change. Existing introduction and getting-started pages, the website homepage/sidebar, and contributor instructions are updated as well.
Breaking changes, API/CLI compatibility impacts, and upgrade steps: None.
Checklist
up()/down()and keep it CosmosDB-compatible. N/A: no database changes.NOTICE/NOTICE-REVIEW.txtwithpnpm noticeas needed. N/A: no dependency changes.