-
Notifications
You must be signed in to change notification settings - Fork 123
docs: update subrequest section #1510
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
base: main
Are you sure you want to change the base?
Conversation
ADubhlaoich
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally LGTM: please ensure your commit messages (in-branch or merge) adhere to our Git conventions as outlined in the checklist part of every PR, which expect Conventional Commits formatting.
✅ Deploy Preview will be available once build job completes!
|
87cbd14 to
f33f40e
Compare
ADubhlaoich
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM still, but you should reconsider how you have changed the headings.
Heading level 4 does not generate in the table of contents, meaning that they require the user to scroll to find them.
I suggest removing the "Additional..." third level subheadings, and renaming the subrequest "Example" heading into a "General example" to ensure that the headings are uniformly consistent from that point on.
|
Perhaps it's worth adding the slice module here as well. |
a9f2a60 to
ae06a88
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM: I can merge this.
ADubhlaoich
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just noticed you added more commits since yesterday.
It is very unclear to me when to review this PR because commits keep being added: I do not understand what the definition of done is meant to look like.
146b51b to
d6cd2bb
Compare
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: yar <y82@users.noreply.github.com>
Co-authored-by: Alan Dooley <a.dooley@f5.com>
bbf08e6 to
e68fe1c
Compare
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩