Enhance documentation with additional descriptions and links for articles, cmdlets, and installation processes; add new llms.txt file for quick reference.#5334
Merged
Conversation
…cles, cmdlets, and installation processes; add new llms.txt file for quick reference.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the PnP PowerShell documentation site for both human readers and AI agents. It introduces stable cross-reference UIDs on key pages so internal links survive future restructuring, adds an llms.txt quick-reference for LLMs, declares a sitemap and _lang for the DocFX site, and adds CSS styling for code-block copy actions.
Changes:
- Added YAML front matter with
uid/title/descriptionto the main index, articles index, cmdlets index, and key articles (installation, registerapplication, authentication, gettingstartedcontributing), and converted internal links toxref:form. - Added
pages/llms.txtas a static AI-oriented entry point, registered as a DocFX resource; added sitemap configuration and_lang: enindocfx.json. - Added CSS in
pages/templates/pnp-modern/public/main.cssto style a.code-actioncopy button on<pre>code blocks, including dark theme and small-viewport variants.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pages/index.md | Adds UID front matter and converts internal links to xref: references. |
| pages/articles/index.md | Adds UID/title/description front matter for the articles landing page. |
| pages/articles/installation.md | Adds UID front matter so other pages can reference it via xref. |
| pages/articles/registerapplication.md | Adds UID front matter and converts an authentication link to xref. |
| pages/articles/authentication.md | Adds UID front matter and converts registerapplication links to xref. |
| pages/articles/gettingstartedcontributing.md | Adds UID front matter and converts a folder-structure link to existing xref. |
| pages/cmdlets/index.md | Adds UID front matter for the cmdlet index. |
| pages/docfx.json | Adds llms.txt resource, _lang: "en" global metadata, and per-glob sitemap configuration. |
| pages/llms.txt | New AI-agent oriented quick reference with curated links to key docs and cmdlets. |
| pages/templates/pnp-modern/public/main.css | Adds copy-button styling for <pre> blocks with light/dark theme and responsive variants. |
Comment on lines
+189
to
+192
| pre:hover > .code-action, | ||
| pre:focus-within > .code-action { | ||
| display: inline-flex; | ||
| } |
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.
Type
Related Issues?
Improve docs
What is in this Pull Request ?
Improve docs for humans and AI