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: fix url rewrite with clean urls #1057

Merged
merged 5 commits into from
Apr 27, 2022
Merged

Conversation

ryanchristo
Copy link
Member

@ryanchristo ryanchristo commented Apr 26, 2022

Description

Navigating to https://docs.regen.network/modules/ directly rewrites the url to https://docs.regen.network/modules.html, which does not read the sidebar and breaks the links. This pull request adds a plugin to prevent this.

This pull request fixes the links but the content is not displayed correctly when navigating directly to modules or commands. I was unable to resolve the issue so opened a followup that would be nice to fix at a later point in time #1058.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@ryanchristo ryanchristo force-pushed the ryan/docs-fix-links branch from 3f78051 to 1bd6711 Compare April 26, 2022 15:16
@codecov
Copy link

codecov bot commented Apr 26, 2022

Codecov Report

Merging #1057 (3303a94) into master (ee54c46) will increase coverage by 0.05%.
The diff coverage is n/a.

❗ Current head 3303a94 differs from pull request most recent head 8e87ffd. Consider uploading reports for the commit 8e87ffd to get more accurate results

@@            Coverage Diff             @@
##           master    #1057      +/-   ##
==========================================
+ Coverage   68.86%   68.91%   +0.05%     
==========================================
  Files         222      222              
  Lines       21385    21385              
==========================================
+ Hits        14726    14738      +12     
+ Misses       5331     5315      -16     
- Partials     1328     1332       +4     
Flag Coverage Δ
experimental-codecov 68.91% <ø> (+0.05%) ⬆️

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

@ryanchristo ryanchristo marked this pull request as ready for review April 26, 2022 15:47
@ryanchristo ryanchristo marked this pull request as draft April 26, 2022 15:53
@ryanchristo ryanchristo force-pushed the ryan/docs-fix-links branch from 7972dea to 1bd6711 Compare April 26, 2022 16:20
@ryanchristo ryanchristo marked this pull request as ready for review April 26, 2022 17:07
@ryanchristo
Copy link
Member Author

Opened a follow up for content not being displayed correctly when navigating directly to modules and commands #1058

@clevinson
Copy link
Member

Weirdly enough, sub-pages of modules still render as expected when linked to directly....

https://deploy-preview-1057--regen-ledger-docs.netlify.app/modules/ecocredit/

This seems like a fine solution for now. I don't think the formatting thing is worth blocking on. If I had any hesitation, it would be in bringing in a package that hasn't been updated in 2 years... but i think this is probably fine. Its a small workaround, and we can update again if the package gets out of date with vuepress.

Copy link
Contributor

@technicallyty technicallyty left a comment

Choose a reason for hiding this comment

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

lgtm!

@ryanchristo ryanchristo enabled auto-merge (squash) April 27, 2022 18:32
@ryanchristo ryanchristo merged commit 7d75fe3 into master Apr 27, 2022
@ryanchristo ryanchristo deleted the ryan/docs-fix-links branch April 27, 2022 20:56
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.

3 participants