Skip to content
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

Fix link to documentation in README #3184

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Conversation

zhaohaidao
Copy link
Contributor

@zhaohaidao zhaohaidao commented Feb 21, 2025

As the title describes, it should be that this PR did not synchronize the modification of the root directory's README.

@alecgrieser alecgrieser added the documentation Documentation change label Feb 21, 2025
@alecgrieser alecgrieser changed the title fix docs link not found issue Fix link to documentation in README Feb 21, 2025
Copy link
Collaborator

@alecgrieser alecgrieser left a comment

Choose a reason for hiding this comment

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

Thanks for catching this!

@@ -39,7 +39,7 @@ layer on which more complex systems can be constructed.

## Documentation

* [Documentation Home](docs/index.md)
* [Documentation Home](docs/sphinx/source/index.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [Documentation Home](docs/sphinx/source/index.md)
* [Documentation Home](https://foundationdb.github.io/fdb-record-layer/)

It's possible we should update this to our documentation site on GitHub Pages, but regardless, having a 404'ingredient link was definitely wrong.

@alecgrieser alecgrieser merged commit ccb6246 into FoundationDB:main Feb 21, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants