Skip to content

🪲 [Fix]: Fix broken documentation links in README.md#18

Merged
Marius Storhaug (MariusStorhaug) merged 3 commits intomainfrom
copilot/fix-17
Jun 25, 2025
Merged

🪲 [Fix]: Fix broken documentation links in README.md#18
Marius Storhaug (MariusStorhaug) merged 3 commits intomainfrom
copilot/fix-17

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jun 25, 2025

The README.md file contained broken documentation links that resulted in 404 errors when users tried to access them.

Issues fixed:

  • Replaced broken [docs](docs) link pointing to non-existent local folder with [Hashtable docs](https://psmodule.io/Hashtable/)
  • Replaced broken [PSModule Documentation](https://psmodule.io) link with [PSModule Docs](https://psmodule.io/docs)
  • Removed reference to non-existent [examples](examples) folder

Before:

For more examples, please refer to the [examples](examples) folder. You can also use `Get-Command -Module 'Hashtable'` to
list available commands, and `Get-Help -Examples <CommandName>` to view command-specific examples.

## Documentation

Detailed documentation for each function is available via inline help. For more extensive documentation, please check the
[docs](docs) folder or visit the online documentation at [PSModule Documentation](https://psmodule.io).

After:

You can use `Get-Command -Module 'Hashtable'` to list available commands, and `Get-Help -Examples <CommandName>` to view command-specific examples.

## Documentation

Detailed documentation for each function is available via inline help. For more extensive documentation, please visit the 
[Hashtable docs](https://psmodule.io/Hashtable/) or [PSModule Docs](https://psmodule.io/docs).

Users can now successfully navigate to the correct documentation URLs without encountering 404 errors.

Co-authored-by: MariusStorhaug <17722253+MariusStorhaug@users.noreply.github.com>
Copilot AI changed the title [WIP] 🪲[Bug]: docs links in readme are broken Fix broken documentation links in README.md Jun 25, 2025
@MariusStorhaug Marius Storhaug (MariusStorhaug) marked this pull request as ready for review June 25, 2025 15:01
Copilot AI review requested due to automatic review settings June 25, 2025 15:01

This comment was marked as outdated.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Fix broken documentation links in README.md 🪲 [Fix]: Fix broken documentation links in README.md Jun 25, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a 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 PR fixes broken documentation links in the README by removing references to non-existent folders and updating URLs to valid online resources.

  • Removed the [examples](examples) folder reference
  • Updated the local [docs](docs) link to point to the online Hashtable documentation
  • Corrected the PSModule documentation URL
Comments suppressed due to low confidence (1)

README.md:105

  • [nitpick] Consider capitalizing 'Docs' in '[Hashtable docs]' to '[Hashtable Docs]' for consistency with '[PSModule Docs]'.
[Hashtable docs](https://psmodule.io/Hashtable/) or [PSModule Docs](https://psmodule.io/docs).

@MariusStorhaug Marius Storhaug (MariusStorhaug) merged commit b38973a into main Jun 25, 2025
36 checks passed
@MariusStorhaug Marius Storhaug (MariusStorhaug) deleted the copilot/fix-17 branch June 25, 2025 15:23
@github-actions
Copy link
Copy Markdown

Module Hashtable - 1.1.6 published to the PowerShell Gallery.

@github-actions
Copy link
Copy Markdown

GitHub release for Hashtable v1.1.6 has been created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🪲[Bug]: docs links in readme are broken

3 participants