Skip to content

docs(README, ci): add docs shield with link to version docs #2814

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

Jump to bottom
Merged
merged 2 commits into from
Mar 3, 2021
Merged

docs(README, ci): add docs shield with link to version docs #2814

merged 2 commits into from
Mar 3, 2021

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Mar 2, 2021 •
edited
Loading

This PR:

  • adds a shield linking to the docs
  • updates the release steps in the ci/README

Screenshot

image

@jsjoeio jsjoeio added this to the v3.9.1 milestone Mar 2, 2021
@jsjoeio jsjoeio self-assigned this Mar 2, 2021
@jsjoeio jsjoeio marked this pull request as ready for review March 2, 2021 22:43
@jsjoeio jsjoeio requested a review from a team as a code owner March 2, 2021 22:43
@jsjoeio jsjoeio changed the base branch from master to main March 2, 2021 22:54
@jsjoeio jsjoeio requested a review from greyscaled March 3, 2021 22:23
greyscaled
greyscaled approved these changes Mar 3, 2021
View reviewed changes
Copy link
Contributor

@greyscaled greyscaled left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM.

I imagine as a next step we might be able to surround this line with a special <!--- ---> markdown comment and automate updating the variable tree/vx.y.z/docs aspect of this badge

@jsjoeio
Copy link
Contributor Author

jsjoeio commented Mar 3, 2021

Yes! That should be part of automating the release (planning to open up an issue for that).

@jsjoeio jsjoeio merged commit 5f42112 into main Mar 3, 2021
@jsjoeio jsjoeio deleted the add-link-docs branch March 3, 2021 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greyscaled greyscaled greyscaled approved these changes

Assignees

@jsjoeio jsjoeio

Labels
None yet
Projects
None yet
Milestone
v3.9.1
Development

Successfully merging this pull request may close these issues.
2 participants
@jsjoeio @greyscaled