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

Link reference docs in README #130

Merged
merged 1 commit into from
Oct 3, 2023
Merged

Link reference docs in README #130

merged 1 commit into from
Oct 3, 2023

Conversation

jhamon
Copy link
Collaborator

@jhamon jhamon commented Oct 3, 2023

Problem

The generated documentation is not linked from the README

Solution

README updates:

  • Link generated reference docs from readme
  • Replace relative links with absolute links, so that they work properly when clicked from within the rendered docs home
  • Consolidate documentation stuff into one section
  • Update and organize badges

See the results here

Type of Change

  • Non-code change (docs, etc)

@jhamon jhamon requested a review from austin-denoble October 3, 2023 15:15
@jhamon jhamon marked this pull request as ready for review October 3, 2023 15:15
Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

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

Looks good, thanks. I was thinking we may also want to update the repos that have generated reference docs to include a link to the docs directly from the "About" header section, if that makes sense.

@jhamon jhamon merged commit 429e8c4 into main Oct 3, 2023
18 checks passed
@jhamon jhamon deleted the jhamon/README-docs-link branch October 3, 2023 15:19
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.

2 participants