Conversation
Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor and optimize documentation for clarity and consistency
Consolidate documentation into single sources of truth with audience split
Jan 25, 2026
blindzero
requested changes
Jan 25, 2026
…iders, enhance extensibility Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
blindzero
requested changes
Jan 25, 2026
Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7f5ccf8609
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates IdLE documentation into single sources of truth and reorganizes navigation by audience (users vs developers).
Changes:
- Established single authoritative sources for installation instructions, provider documentation, and core concepts
- Reorganized docs/index.md and docs/_sidebar.md with clear user/developer split
- Converted docs/usage/providers.md to quick reference that links to comprehensive docs/reference/providers-and-contracts.md
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage/providers.md | Converted to quick reference with links to comprehensive provider documentation |
| docs/reference/providers-and-contracts.md | Consolidated all provider concepts, contracts, auth, and usage patterns into single source |
| docs/overview/concept.md | Enhanced with "Building Blocks" section and key features |
| docs/index.md | Reorganized by audience with clear user vs developer documentation sections |
| docs/getting-started/installation.md | Clarified requirements, import options, and provider module usage |
| docs/advanced/extensibility.md | Streamlined AuthSessionBroker section with link to detailed reference |
| docs/_sidebar.md | Split navigation into "User Documentation" and "Developer Documentation" sections |
| README.md | Simplified with restored "Why IdLE?" section and links to detailed documentation |
blindzero
requested changes
Jan 25, 2026
Co-authored-by: blindzero <13959569+blindzero@users.noreply.github.com>
blindzero
approved these changes
Jan 25, 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.
Documentation Consolidation - COMPLETE ✓
Summary
Successfully refactored, consolidated, and optimized documentation according to issue requirements.
Changes Made
1. Installation & Import Policy
Single Source:
docs/getting-started/installation.mdResult: Installation instructions exist in ONE place instead of 3+ places
2. Provider Documentation
Single Source:
docs/reference/providers-and-contracts.mdNew-IdleEntraIDIdentityProvider(correct spelling with "ID")Result: Provider documentation consolidated from 3 partial sources into 1 comprehensive reference
3. Overview & Concepts
Single Source:
docs/overview/concept.mdResult: Concept information reduced from 2+ places to 1 authoritative source
4. Audience-Based Navigation
docs/_sidebar.mdwith clear "User Documentation" and "Developer Documentation" sectionsResult: Clear separation makes it easy for users vs contributors to find relevant content
Files Modified
Principles Applied
✓ Single source of truth for each topic
✓ Drill-down for details (high-level docs link to detailed docs)
✓ Audience awareness (users vs developers)
✓ Avoid sprawl (consolidated instead of creating new docs)
✓ Maintain discoverability (clear navigation structure)
Verification
✓ All key documentation files exist
✓ No broken internal links
✓ Navigation organized by audience (GitHub Pages _sidebar.md updated)
✓ README includes "Why IdLE?" section with concept link
✓ Consistent terminology (provider, not adapter)
✓ Installation note about meta-module restored
✓ Cmdlet names match actual implementation (New-IdleEntraIDIdentityProvider)
Impact
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.