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

Add link to docs to README #542

Merged
merged 1 commit into from
Apr 15, 2024
Merged

Add link to docs to README #542

merged 1 commit into from
Apr 15, 2024

Conversation

kayabaNerve
Copy link
Contributor

Motivation

While the GH repo's site is the docs page, that is off-center (and not rendered when viewing the repository via a cloned local view). I had to be explicitly told the docs site existed due to not noticing that location (nor any other which may or may not exist). Ideally, the README includes the link somewhere.

Solution

This adds a link in a location with no changes to layout.

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

While the GH repo's site is the docs page, that is off-center (and not rendered when viewing the repository via a cloned local view). I had to be explicitly told the docs site existed due to not noticing that location (nor any other which may or may not exist). Ideally, the README includes the link *somewhere*. This is a location with no changes to layout.
Copy link
Member

@gakonst gakonst left a comment

Choose a reason for hiding this comment

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

tyty!

@gakonst gakonst merged commit 0f24ca4 into alloy-rs:main Apr 15, 2024
@kayabaNerve kayabaNerve deleted the patch-2 branch April 15, 2024 14:57
ben186 pushed a commit to ben186/alloy that referenced this pull request Jul 27, 2024
While the GH repo's site is the docs page, that is off-center (and not rendered when viewing the repository via a cloned local view). I had to be explicitly told the docs site existed due to not noticing that location (nor any other which may or may not exist). Ideally, the README includes the link *somewhere*. This is a location with no changes to layout.
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.

2 participants