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] Use correct header heirarchy in airbyte-protocol docs #18917

Merged
merged 3 commits into from
Nov 7, 2022

Conversation

erohmensing
Copy link
Contributor

@erohmensing erohmensing commented Nov 3, 2022

What

  • Makes Actor Specification and other currently-h1 headers linkable, makes links to them resolve, and discoverable in the sidebar. See my issues with how things weren't working currently in this Loom

How

We could also enforce/test this hierarchy if we wanted to, happy to create an issue if people think that would be helpful. Example here both checks that there are no other h1s in the doc and that the hierarchy doesn't skip a level.

@erohmensing erohmensing requested a review from a team as a code owner November 3, 2022 16:02
@erohmensing erohmensing marked this pull request as draft November 3, 2022 16:03
@erohmensing
Copy link
Contributor Author

Loom opened it before I was ready 😄

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Nov 3, 2022
@erohmensing erohmensing marked this pull request as ready for review November 3, 2022 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants