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

chore: Add support for hierarchical docs #5278

Merged
merged 2 commits into from
Jul 7, 2023
Merged

chore: Add support for hierarchical docs #5278

merged 2 commits into from
Jul 7, 2023

Conversation

silvanocerza
Copy link
Contributor

Proposed Changes:

Add parentDocSlug in API reference docs frontmatter.
Set renderer.parent_doc_slug in docs config yamls to create the hierarchy.

How did you test it?

I generated docs locally and uploaded them to Readme.io to verify the hierarchy would be created correctly.

Notes for the reviewer

An empty or unset parent_doc_slug won't make render or upload fail.

Checklist

@silvanocerza silvanocerza self-assigned this Jul 5, 2023
@silvanocerza silvanocerza requested a review from a team as a code owner July 5, 2023 15:53
@silvanocerza silvanocerza requested review from bogdankostic and removed request for a team July 5, 2023 15:53
@coveralls
Copy link
Collaborator

coveralls commented Jul 5, 2023

Pull Request Test Coverage Report for Build 5476992039

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 44.659%

Totals Coverage Status
Change from base Build 5476747209: 0.0%
Covered Lines: 10281
Relevant Lines: 23021

💛 - Coveralls

@silvanocerza silvanocerza merged commit d6f855c into main Jul 7, 2023
47 checks passed
@silvanocerza silvanocerza deleted the docs-parents branch July 7, 2023 15:00
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.

None yet

3 participants