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 resources docsify pages #48

Merged
merged 18 commits into from
Aug 28, 2020
Merged

Conversation

whoabuddy
Copy link
Member

@whoabuddy whoabuddy commented Aug 25, 2020

Based on observations clicking around the new docsify site and those listed in stacksgov/pm#90.

@whoabuddy whoabuddy marked this pull request as draft August 25, 2020 00:10
@whoabuddy whoabuddy marked this pull request as ready for review August 25, 2020 22:23
@whoabuddy whoabuddy requested review from lrettig and blocks8 August 25, 2020 22:23
@whoabuddy
Copy link
Member Author

There is a little more that I could do to clean up the notes, but the main goal of this PR was to get all of the links working again, and to provide basic navigation so that if I click from the main readme into a folder, then I have a clear path back without having to use the back button.

There were also some basic things, like adding titles and some copy updates to try and make things more evergreen and consistent.

@lrettig note that the relative links should be working in this format now based on the setting we updated in the last PR, there was one that we missed and I was able to test, so I followed that format to keep everything as simple as possible.

@whoabuddy
Copy link
Member Author

whoabuddy commented Aug 25, 2020

Oh, and another major update was in two docsify settings:

  1. for links to external files, using the syntax:

[Presentation Slides](20200213_community_call_001.pdf ':ignore')

This tells docsify to not try and render the file per the documentation here, and should resolve the 404s for those as well.

  1. for pages that land in the center of the page instead of at the top, added the config line:

auto2top: true

This tells docsify to automatically scroll to the top when loading a new link, which can be overridden by using a specific ?id=xyz on the end of the URL.

If all of this looks good I can do a similar sweep across the stacksgov/pm repo.

@whoabuddy whoabuddy requested a review from joberding August 25, 2020 22:30
Copy link
Contributor

@lrettig lrettig left a comment

Choose a reason for hiding this comment

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

Ran docsify locally, clicked around, everything looked good except the relative links in the survey folder README - for some reason, docsify gets confused by relative links in subfolders. I made these into absolute links and everything now LGTM

Copy link
Contributor

@joberding joberding left a comment

Choose a reason for hiding this comment

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

Took a look. Do you need any help @whoabuddy

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