Repository navigation
docs: simplify documentation structure and troubleshooting - #54
Merged
Hou (SciencePotato) merged 13 commits intoOct 15, 2026
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4fe53050-0d2b-4d05-bcc1-20f5b611b665
siyixian
previously approved these changes
Oct 15, 2026
siyixian
approved these changes
Oct 15, 2026
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
docs/GETTING-STARTED.mdand retain the safety/eligibility gates.docs/README.mdas the complete task index.docs/LOGGING.md; keepCONTRACT.md#application-logsas a useful compatibility link. Keep precise API, setting, status, cache, and runtime details in their canonical references.Full structure pass
Reviewed every tracked guide, not only the earlier three-file reduction. The cost-report script, permissions, and estimate safeguards remain unchanged; only its surrounding explanation is simpler. Hosting-cost work remains separate.
The new index replaces duplicated reference catalogs. Root guidance now routes each goal directly to its starting page, while the documentation index groups the remaining guides by task. Setup permissions, certificate choices, renewal, and rollback stay in the setup reference. Provider credentials, IDs, acceptance checks, and exact Easy Auth settings stay in customer configuration. Runtime guides link to those rules while retaining their local examples, source maps, binding differences, and credential lifecycles. Operational monitoring points to collection diagnostics and the focused log schema rather than repeating them.
The BYOT page remains provider-neutral and instructions-only. Identity monitoring remains beginner-first with no inline KQL. Advanced regional/fallback designs keep their detailed capacity, uncertainty, privacy, abort, and restoration safeguards.
Measured reduction
The full structural pass reduces all documentation from 52,664 to 43,886 whitespace-delimited Markdown words, a net reduction of 8,778 (16.7%), including both new pages, expanded landing-page navigation, the BCDR section, and the complete prose review. The final concise pass removes 4,516 words from the previous published head across all 19 pages. Counts are measured against the previously published PR54 head
c2827d8f8db56b3248fd5796a18c50db78b0ef25, not a selectively chosen page.Across the complete PR, the root README changes from 1,997 to 406 words. It now follows the reference repository's layered structure without moving the detailed setup walkthrough back into the landing page. Precise tables and examples are deliberately retained.
Per-page structural-pass counts and relocation accounting
README.mdTECHNICAL.mddocs/APPLICATION-INSIGHTS.mddocs/BRING-YOUR-OWN-PROVIDER.mddocs/CONTRACT.mddocs/COST-CALCULATOR.mddocs/FRONTDOOR.mddocs/GETTING-STARTED.mddocs/LOGGING.md(new focused reference)docs/MONITORING.mddocs/MULTI-PROVIDER-IMPLEMENTATION.mddocs/ONBOARDING.mddocs/README.md(new task index)docs/SIGN-IN-MONITORING.mddotnet/README.mdjavascript/README.mdpython/README.mdsetup/docs/README.mdsetup/docs/Troubleshooting.mdCounts include markup, links, code, and tables consistently. The contract's reduction includes relocating its logging section; the new logging page is included in the after-total, so relocation is not counted as deletion.
Validation
git diff --check.Local previews approximate GitHub styling rather than testing its hosted renderer. Existing wide tables/code scroll within their containers; the preserved architecture image needs its full-size link for small labels. External URL availability was not checked. No runtime suite, live query, Azure sign-in/deployment, provider send, or paid action was run. No repository tooling/dependencies were added.
Integration
Base: upstream
main,ce68ee2649d8e4ab64e00c4abece33e939cdfa9c. No unmerged commits from #53 are imported, and #50's hosting-cost work is not duplicated.#53 shares TECHNICAL, BYOT, Front Door, configuration, runtime READMEs, and setup-reference files. The earlier diagram relocation still overlaps TECHNICAL's image section; this structural continuation leaves that section unchanged. When integrating, place #53's unique screenshot/sequence guidance alongside the new task navigation rather than restoring repeated overview prose. All original images remain unchanged.
No merge or Agent merge is requested.