openapi tutorial layout #279
Conversation
✅ Deploy Preview for bump-content-hub ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
thimy
force-pushed
the
openapi-tutorial-layout
branch
from
9c104bc
to
8272b98
Compare
|
Not sure how far this relates to this PR, but there is an issue with wide tables. Example: https://deploy-preview-279--bump-content-hub.netlify.app/guides/openapi/specification/v3.1/understanding-structure/parameter-serialization/#query-parameters
Should we consider larger content zones? |
|
It isn't clear in mind mind anymore: did we not want to keep the "next article"/"previous article at the end of pages? This, or have the scroll only on the content area, not on the side bar, so that the index is always visible. |
|
Apart from those two comments, this looks gorgeous, thanks @thimy and @grossyoan ! |
|
Hi Thimy! Thanks for this amazing work.
|
thimy
force-pushed
the
openapi-tutorial-layout
branch
from
8272b98
to
f07a093
Compare
|
Sorry, I didn't want to show entrypoints to the guide while they were not approved but that was a bit stupid since you can't review the layout. xd |
thimy
force-pushed
the
openapi-tutorial-layout
branch
4 times, most recently
from
fe9af8c
to
0c34df5
Compare
|
I have added the prev/next navigation and added css classes to add on a per table basis to fix the overflowing content.
|
|
Perfect! Could you rename "OpenAPI" to "OpenAPI Specification" in the navbar? So we're good on that part too. Thanks a lot for all this good work Thimy! |
thimy
force-pushed
the
openapi-tutorial-layout
branch
from
4378122
to
1da3b3a
Compare
|
Done ✅ |
Adds a frontmatter attribute that hides an entry from being listed in the main guides page.
To be added on a per table basis. * full-bleed lets the table expand beyond the text column * break-word make table content break and wrap instead of forcing width based on content Also added `white-space: nowrap` to `code` in `th` so column name doesn't get squeezed.
thimy
force-pushed
the
openapi-tutorial-layout
branch
from
1da3b3a
to
1063ba9
Compare
|
I removed Phil's commits to avoid noise, may I have a technical review please? 🙏 |
| <button data-button-style="secondary" data-button-size="small" data-toggle-target="button" data-action="toggle#click"> | ||
| Show menu <svg width="11" height="12" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="m10 6 .543.517a.75.75 0 0 0 0-1.034L10 6ZM0 6.75h10v-1.5H0v1.5Zm10.543-1.267-4.762-5-1.086 1.034 4.762 5 1.086-1.034Zm-1.086 0-4.762 5 1.086 1.034 4.762-5-1.086-1.034Z" fill="#025FD7"/></svg> | ||
| </button> | ||
| <h1><%= data.title %></h1> |
There was a problem hiding this comment.
You are gona have 2< h1 >in the page?
There was a problem hiding this comment.
I'm not sure I understand what you mean, we always skip adding # in markdown content and we put the main title in the frnotmatter in case we need to retrieve it as data.
There was a problem hiding this comment.
As discussed, if we have some tags that reset the h* hierarchy, like section define in the Sidebar component, that's not a subject
| <button data-button-style="secondary" data-button-size="small" data-toggle-target="button" data-action="toggle#click"> | ||
| Show menu <svg width="11" height="12" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="m10 6 .543.517a.75.75 0 0 0 0-1.034L10 6ZM0 6.75h10v-1.5H0v1.5Zm10.543-1.267-4.762-5-1.086 1.034 4.762 5 1.086-1.034Zm-1.086 0-4.762 5 1.086 1.034 4.762-5-1.086-1.034Z" fill="#025FD7"/></svg> | ||
| </button> | ||
| <h1><%= data.title %></h1> |
There was a problem hiding this comment.
As discussed, if we have some tags that reset the h* hierarchy, like section define in the Sidebar component, that's not a subject
This PR depends on #277
I left Phil's commits so we can check how it renders but what really counts is the last commit, I'll remove them once this gets approved.
There's also a commit that fixes links in markdown that will go to #256.
@ChristopheDujarric you can start reviewing Phil's posts from here but comments will have to go to #256.