Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Topic/update docs 2 #2319

Merged
merged 8 commits into from
Sep 2, 2024
Merged

Topic/update docs 2 #2319

merged 8 commits into from
Sep 2, 2024

Conversation

MrHinsh
Copy link
Member

@MrHinsh MrHinsh commented Aug 30, 2024

Update layouts

…idebar links

Update the MigrationTools.xml file to reflect the latest commit details, including branch, commit hash, and version tags. Fix broken links in the sidebar and add missing links to improve navigation.

The changes ensure that the documentation is up-to-date with the latest codebase and that users can navigate the documentation more effectively.

📝 (docs): update default layout to include support and community links

Add a new card section in the sidebar to provide users with quick access to community and commercial support resources. This enhances user experience by making it easier to find help and support options.

Additionally, change the table of contents (TOC) setting in the index.md file from true to false to improve page readability.

📝 (docs): update ReflectedWorkItemId.md and index.md for clarity and completeness

Add detailed instructions on how to add the `ReflectedWorkItemId` for different environments (Azure DevOps, TFS). Improve the structure and readability of the documentation. Update the index.md to provide a clear setup guide, including installation, permissions, and usage of the `ReflectedWorkItemId`. These changes aim to make the setup process more user-friendly and comprehensive.

📝 (permissions.md): remove outdated and redundant migration state instructions

The migration state instructions are outdated and redundant, as the process has been simplified and documented elsewhere. This cleanup reduces confusion and ensures the documentation remains concise and relevant.
@nkdagility-actions-bot nkdagility-actions-bot bot added documentation This is an item for a Documentation enhancement feature labels Aug 30, 2024
@MrHinsh MrHinsh merged commit 02994fe into main Sep 2, 2024
11 checks passed
@MrHinsh MrHinsh deleted the topic/update-docs-2 branch September 2, 2024 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is an item for a Documentation enhancement feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant