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 broken links [#1569] #1570

Merged
merged 5 commits into from
Aug 16, 2024
Merged

Fix broken links [#1569] #1570

merged 5 commits into from
Aug 16, 2024

Conversation

genehack
Copy link
Contributor

@genehack genehack commented Aug 8, 2024

Description of proposed changes

  • adds linkchecker config to augur
  • rewrite some markdown doc files into RST to facilitate linking in the "proper" way
  • fix broken links as reported by linkchecker

Related issue(s)

Closes #1569

Checklist

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
@genehack genehack force-pushed the fix-broken-links-1569 branch 2 times, most recently from 3099035 to 100caba Compare August 15, 2024 17:29
@genehack
Copy link
Contributor Author

@victorlin thanks for the detailed review. I've fixed everything you noted, and done a further side-by-side comparison of both the v5->v6 and the v6 docs — I think these are now as close as possible to the originals, and generally better in a couple respects (e.g., the side by side config in the new version is IMO much nicer).

Copy link

codecov bot commented Aug 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.51%. Comparing base (66e903a) to head (3e4a5a9).
Report is 11 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1570      +/-   ##
==========================================
+ Coverage   70.23%   70.51%   +0.28%     
==========================================
  Files          76       78       +2     
  Lines        7990     8107     +117     
  Branches     1946     1966      +20     
==========================================
+ Hits         5612     5717     +105     
- Misses       2092     2100       +8     
- Partials      286      290       +4     

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

Copy link
Member

@victorlin victorlin left a comment

Choose a reason for hiding this comment

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

I went through all the changes this time so these should be the final tweaks to be made.

docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/releases/migrating-v5-v6.rst Outdated Show resolved Hide resolved
docs/faq/what-is-a-build.md Show resolved Hide resolved
@genehack
Copy link
Contributor Author

I went through all the changes this time so these should be the final tweaks to be made.

All addressed; ready for final check.

@genehack genehack merged commit 988380c into master Aug 16, 2024
28 checks passed
@genehack genehack deleted the fix-broken-links-1569 branch August 16, 2024 18:44
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.

Fix broken links in docs
2 participants