Skip to content

docs: update stac readme links #370

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 14, 2025
Merged

docs: update stac readme links #370

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/stac/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,20 @@ This approach separates your app's presentation layer from its business logic, e
## Documentation

- 📚 **[Full Documentation](https://docs.stac.dev/)** – Complete guides and API reference
- 🚀 **[Quick Start](https://docs.stac.dev/get_started/quick_start)** – Get up and running in minutes
- 🚀 **[Quick Start](https://docs.stac.dev/quickstart)** – Get up and running in minutes
- 🛠️ **[Stac CLI](https://docs.stac.dev/cli)** – Command-line tools for development
- 🎛️ **[Stac Console](https://console.stac.dev/)** – Web interface for managing your app
- 🤝 **[Contributing](https://github.com/StacDev/stac/blob/main/CONTRIBUTING.md)** – Help build Stac
- 🤝 **[Contributing](../../CONTRIBUTING.md)** – Help build Stac

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/StacDev/stac/blob/dev/LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
Comment on lines +51 to +55
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Restore absolute links for cross-site rendering.

Switching to repo-relative paths (../../CONTRIBUTING.md, /LICENSE) breaks these links anywhere the README is rendered outside GitHub (e.g., pub.dev resolves them to https://pub.dev/…, resulting in 404). Please keep them as explicit GitHub URLs so they work universally.

-🤝 **[Contributing](../../CONTRIBUTING.md)** – Help build Stac
+🤝 **[Contributing](https://github.com/StacDev/stac/blob/dev/CONTRIBUTING.md)** – Help build Stac
 …
-This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/StacDev/stac/blob/dev/LICENSE) file for details.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- 🤝 **[Contributing](../../CONTRIBUTING.md)** – Help build Stac
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/StacDev/stac/blob/dev/LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](/LICENSE) file for details.
🤝 **[Contributing](https://github.com/StacDev/stac/blob/dev/CONTRIBUTING.md)** – Help build Stac
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/StacDev/stac/blob/dev/LICENSE) file for details.
🤖 Prompt for AI Agents 
packages/stac/README.md lines 51-55: the README uses repository-relative links
("../../CONTRIBUTING.md" and "/LICENSE") which break when rendered off GitHub;
replace them with absolute GitHub URLs (e.g.,
https://github.com/<owner>/<repo>/blob/main/CONTRIBUTING.md and
https://github.com/<owner>/<repo>/blob/main/LICENSE) so the links resolve
correctly on external sites and package registries.


## Join our community

- 💬 **[Discord](https://discord.com/invite/vTGsVRK86V)** – Chat with the community and get help
- 🐙 **[GitHub](https://github.com/StacDev/stac)** – Report issues and contribute
- 🐦 **[Twitter](https://twitter.com/stacdev)** – Follow us for updates
- 🐦 **[X](https://x.com/stac_dev)** – Follow us for updates

---

Expand Down