Skip to content

fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README #314

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

Open
zeemy23 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): remove broken STYLE_GUIDE.md link and fix docs site URL in README #314

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
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## About This Repository

This repository contains the source code for the [OpenTDF documentation website](https://opentdf.io), built using [Docusaurus](https://docusaurus.io/). The documentation provides comprehensive guides, tutorials, and reference materials for developers and organizations implementing data-centric security with OpenTDF.
This repository contains the source code for the [OpenTDF documentation website](https://docs.opentdf.io), built using [Docusaurus](https://docusaurus.io/). The documentation provides comprehensive guides, tutorials, and reference materials for developers and organizations implementing data-centric security with OpenTDF.

## What is OpenTDF?

Expand Down Expand Up @@ -33,11 +33,9 @@ We welcome contributions to improve our documentation! Please see our [Contribut
- Review and approval process
- Technical setup for contributors

For style guidelines, please refer to our [Style Guide](STYLE_GUIDE.md).
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 1, 2026

Choose a reason for hiding this comment

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

medium

The removal of the STYLE_GUIDE.md link is correct as the file is missing. However, the list item above (line 32) still references "Style and formatting standards". If these standards are now primarily covered by the Vale configuration or the upstream contributing guide, it would be beneficial to update the list or add a brief mention of where these standards can now be found to avoid ambiguity for new contributors.


## Quick Links

- **Live Documentation**: [docs.opentdf.io](https://opentdf.io)
- **Live Documentation**: [docs.opentdf.io](https://docs.opentdf.io)
- **OpenTDF Platform**: [github.com/opentdf/platform](https://github.com/opentdf/platform)
- **TDF Format Spec**: [github.com/opentdf/spec](https://github.com/opentdf/spec)
- **OpenTDF Organization**: [github.com/opentdf](https://github.com/opentdf)
Expand Down
Loading