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

docs: update badge on front page #755

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Conversation

richardjgowers
Copy link
Contributor

fixes #312

This badge should point to stable/released docs, so people are linked to what documents the thing that they are most likely to be using. Most people will be using conda builds, not dev/source builds, if they're using dev builds they'll also know how to get to the dev docs.

Removed disclaimer on pre-alpha status, we're 1.0rc

Checklist

  • Added a news entry

Developers certificate of origin

Copy link

codecov bot commented Mar 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.76%. Comparing base (d05074e) to head (b032443).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #755   +/-   ##
=======================================
  Coverage   91.76%   91.76%           
=======================================
  Files         133      133           
  Lines        9747     9747           
=======================================
  Hits         8944     8944           
  Misses        803      803           
Flag Coverage Δ
fast-tests 91.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This badge should point to stable/released docs, so people are linked to what documents the thing that they are most likely to be using.  Most people will be using conda builds, not dev/source builds, if they're using dev builds they'll also know how to get to the dev docs.

Removed disclaimer on pre-alpha status, we're 1.0rc
@mikemhenry
Copy link
Contributor

Good example of something not needing the changelog entry.
image

I double-checked and by default we show the stable version on docs.openfree.energy

Copy link
Contributor

@mikemhenry mikemhenry left a comment

Choose a reason for hiding this comment

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

image

Once this is fixed, feel free to dismiss my review and merge it in

@richardjgowers richardjgowers merged commit c467874 into main Mar 11, 2024
10 checks passed
@richardjgowers richardjgowers deleted the issue-312-docs_badge branch March 11, 2024 14:35
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.

[docs] add docs badge
2 participants