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

Documentation Cleanup: landing page, getting-started, and guide/bundles #194

Merged
merged 2 commits into from Nov 29, 2021

Conversation

JKomoroski
Copy link
Contributor

Here is my first foray into tightening up the documentation. This PR is only over three files, If it is welcomed I will do more.

I attempted to keep the content and meaning the same, only making adjustments to grammar, spelling, and phrasing (idiomatic English is a nightmare, I can't imagine trying to learn the nuances as a second language).

Now that I've started going through it in detail, I have a list of changes I'd like to make to standardize documentation, but I'll open an issue with those suggestions before I implement them.

@codecov-commenter
Copy link

codecov-commenter commented Nov 28, 2021

Codecov Report

Merging #194 (ff887c1) into master (803adb7) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #194   +/-   ##
=========================================
  Coverage     95.38%   95.38%           
  Complexity     2525     2525           
=========================================
  Files           216      216           
  Lines          6041     6041           
  Branches        792      792           
=========================================
  Hits           5762     5762           
  Misses          113      113           
  Partials        166      166           
Flag Coverage Δ
LINUX 95.36% <ø> (-0.02%) ⬇️
windows 95.36% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 803adb7...ff887c1. Read the comment docs.

Copy link
Owner

@xvik xvik left a comment

Choose a reason for hiding this comment

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

Thank you very much! I have just a few remarks, could you please correct them (or tell me if I'm wrong in some of them)

src/doc/docs/getting-started.md Outdated Show resolved Hide resolved
src/doc/docs/getting-started.md Outdated Show resolved Hide resolved
src/doc/docs/getting-started.md Outdated Show resolved Hide resolved
src/doc/docs/getting-started.md Outdated Show resolved Hide resolved
src/doc/docs/getting-started.md Outdated Show resolved Hide resolved
src/doc/docs/guide/bundles.md Outdated Show resolved Hide resolved
src/doc/docs/guide/bundles.md Outdated Show resolved Hide resolved
@JKomoroski
Copy link
Contributor Author

Addressed each of your comments in a second commit.

@JKomoroski JKomoroski requested a review from xvik November 29, 2021 14:41
@xvik xvik merged commit d7e50e9 into xvik:master Nov 29, 2021
@xvik
Copy link
Owner

xvik commented Nov 29, 2021

Perfect! Thank you very much!

@xvik
Copy link
Owner

xvik commented Dec 7, 2021

All changes were finally published with an updated documentation site (updated features like version switcher, dark theme, new latest version alias - documentation itself remained the same)

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