Skip to content

Conversation

@curogom
Copy link
Contributor

@curogom curogom commented Oct 14, 2025

Description

  • replace the outdated Quick Start link with the working docs URL
  • switch internal CONTRIBUTING and LICENSE links to repo-relative paths
  • update the social link label to X while pointing at the new profile URL

Related Issues

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code refactor
  • Build configuration change
  • Documentation
  • Chore

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start link to the new docs location to prevent broken or outdated links.
    • Adjusted Contributing link to a repository-relative path for consistent in-repo navigation.
    • Updated License reference to point to the local LICENSE file for clearer licensing information.
    • Renamed social link from Twitter to X and updated the handle and URL accordingly.

@CLAassistant
Copy link

CLAassistant commented Oct 14, 2025

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Updated documentation links and references in packages/stac/README.md: Quick Start URL changed to https://docs.stac.dev/quickstart; Contributing and License references now point to local files; social handle label changed from Twitter to X with URL https://x.com/stac_dev. (45 words)

Changes

Cohort / File(s) Summary of Changes
README link and reference updates
packages/stac/README.md
Updated Quick Start URL to https://docs.stac.dev/quickstart; changed Contributing link to ../../CONTRIBUTING.md; updated License reference to local LICENSE; renamed "Twitter" to "X" and updated URL to https://x.com/stac_dev.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • rahulbisht25
  • Potatomonsta

Poem

I hop through docs with nimble feet,
Links aligned, concise and neat.
Contrib close, License near,
Quickstart’s path is crystal clear.
On X I squeak, “All set!” — hooray, my dear. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly highlights that this documentation PR updates the STAC README links. It uses the “docs:” prefix to clearly indicate its scope and remains concise. This phrasing directly corresponds to the main changes without introducing unrelated details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea09b7c and 97b511d.

📒 Files selected for processing (1)
  • packages/stac/README.md (1 hunks)

@curogom curogom force-pushed the docs/update-readme-links branch 2 times, most recently from 35a9df4 to 961db14 Compare October 14, 2025 04:06
@curogom curogom force-pushed the docs/update-readme-links branch from 961db14 to 50da2ff Compare October 14, 2025 04:52
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 961db14 and 50da2ff.

📒 Files selected for processing (1)
  • packages/stac/README.md (1 hunks)

Comment on lines +51 to +55
- 🤝 **[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.
Copy link
Contributor

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.

@divyanshub024 divyanshub024 merged commit 67cebde into StacDev:dev Oct 14, 2025
2 checks passed
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.

4 participants