-
Notifications
You must be signed in to change notification settings - Fork 797
Docs: Update readme and website #3256
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request reorganizes and updates the NETworkManager documentation to improve clarity and user experience. The changes consolidate feature documentation into the introduction page, update sidebar navigation positions, and refine messaging across the README and website.
Key Changes
- Migrated features list, profiles, and languages sections from
features.mdintointroduction.mdxfor a more comprehensive introduction - Updated README and website descriptions to reflect current tool capabilities and removed outdated references
- Reorganized documentation sidebar positions for better navigation flow
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updated tool descriptions, fixed documentation links, revised installation instructions, and updated build prerequisites |
| Website/src/components/HomepageFeatures/index.js | Simplified and clarified feature descriptions for remote management and profiles |
| Website/docs/introduction.mdx | Enhanced with features list, profiles, and languages sections previously in features.md |
| Website/docs/features.md | Removed (content migrated to introduction.mdx) |
| Website/docs/groups-and-profiles.md | Updated internal link to point to introduction.md instead of features.md |
| Website/docs/settings/appearance.md | Removed outdated AWS Session Manager reference from PowerShell integration documentation |
| Website/docs/*/category.json | Adjusted sidebar positions for improved navigation (Changelog→1, Application→2, Settings→3, Groups and Profiles→4, Command Line Arguments→5) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
BornToBeRoot
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Changes proposed in this pull request
Related issue(s)
Copilot generated summary
Provide a Copilot generated summary of the changes in this pull request.
Copilot summary
This pull request focuses on improving the clarity, accuracy, and consistency of the documentation for NETworkManager. Major updates include a rewritten and streamlined README, a reorganization of documentation content and sidebar positions, and the migration of feature and profile information to a more prominent place in the introduction. These changes aim to provide a better onboarding experience for new users and make it easier to find key information.
Documentation content and structure improvements:
README.mdhas been rewritten for clarity, with updated descriptions of features, tools, and profiles, improved language, and more prominent warnings about pre-release versions. References to features and documentation links have been updated for accuracy. [1] [2] [3] [4] [5]features.mdhave been moved and integrated intointroduction.mdx, making the introduction a comprehensive overview and removing the now-redundantfeatures.mdfile. [1] [2]Sidebar and navigation reorganization:
Application,Changelog,Settings,Command Line Arguments, andGroups and Profilesnow have updated positions. [1] [2] [3] [4] [5]Homepage and feature description updates:
Contributing
By submitting this pull request, I confirm the following: