Skip to content

Fix some docs phrasings and headers #670

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.

Sign up for GitHub

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

Jump to bottom
Merged
htahir1 merged 11 commits into from
Jun 3, 2022
Merged

Fix some docs phrasings and headers #670

htahir1 merged 11 commits into from
Jun 3, 2022

Conversation

@strickvl
Copy link
Contributor

@strickvl strickvl commented May 31, 2022

...as mentioned in a livecoding session just now...

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • If I have added an integration, I have updated the integrations table.
  • I have added tests to cover my changes.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@strickvl strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels May 31, 2022
@strickvl strickvl requested a review from htahir1 May 31, 2022 14:46
@htahir1 htahir1 requested a review from AlexejPenner May 31, 2022 16:24
strickvl
strickvl commented Jun 1, 2022
View reviewed changes
@htahir1 htahir1 removed their request for review June 1, 2022 09:32
htahir1 and others added 2 commits June 1, 2022 11:32
htahir1
htahir1 requested changes Jun 2, 2022
View reviewed changes
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Great changes. Especially moving the run name section makes a lot of sense. Overall I would push to have the headline usage somewhat standardized across pages, i.e. where to use h1, h2, ... This still seems a bit inconsistent.

  • Felix fromHamza's machine

@htahir1 htahir1 requested review from fa9r and htahir1 June 2, 2022 12:54
@htahir1
Copy link
Contributor

htahir1 commented Jun 2, 2022

I added @fa9r as a reviewer as you made this review from my PC :D. @AlexejPenner maybe also take a look?

@htahir1
Copy link
Contributor

htahir1 commented Jun 3, 2022

@AlexejPenner and @fa9r please do take a look when you have time

fa9r
fa9r approved these changes Jun 3, 2022
View reviewed changes
Copy link
Contributor

@fa9r fa9r left a comment

Choose a reason for hiding this comment

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

LGTM now :)

AlexejPenner
AlexejPenner approved these changes Jun 3, 2022
View reviewed changes
Copy link
Contributor

@AlexejPenner AlexejPenner left a comment

Choose a reason for hiding this comment

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

🚀

@htahir1 htahir1 merged commit 6ddb0f8 into develop Jun 3, 2022
@htahir1 htahir1 deleted the misc/docs-fixes branch June 3, 2022 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexejPenner AlexejPenner AlexejPenner approved these changes

@htahir1 htahir1 Awaiting requested review from htahir1

+1 more reviewer

@fa9r fa9r fa9r approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation internal To filter out internal PRs and issues

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@strickvl @htahir1 @fa9r @AlexejPenner