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.

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

Update welcome page of the user docs. #474

Merged
merged 1 commit into from
Feb 2, 2024
Merged

Update welcome page of the user docs. #474

merged 1 commit into from
Feb 2, 2024

Conversation

deoxys94
Copy link
Contributor

@deoxys94 deoxys94 commented Jan 28, 2024 •
edited
Loading

Description

  • Update the contents to align with the style guide (Remove passive voice and ambiguous pronouns, use a friendly, more conversational tone, shorten sentences to improve readability).
  • Change the headers to sentence case.
  • Restructure the contents using tables to improve scannability.
  • Add short descriptions for some of the missing sections.

Submitter Checklist

  • Squashed commits with git rebase -i (if needed)

davidjharder
davidjharder requested changes Jan 28, 2024
View reviewed changes
Copy link
Member

@davidjharder davidjharder left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I like this re-arrangement.
Here are some initial review comments, I'll review the writing a little later.

docs/user/intro.md Outdated Show resolved Hide resolved
docs/user/intro.md Outdated Show resolved Hide resolved
@davidjharder
Copy link
Member

Writing looks good.

Please run prettier to format the tables.

@davidjharder
Copy link
Member

This needs a rebase now.

@deoxys94
Update welcome page of the user docs.
d7cc362 
- Update the contents to allign with the style guide (Remove passive voice and ambiguous pronouns, use a friendly, more conversational tone, shortened sentences to improve readability).
- Change the headers to sentence case.
- Restructure the contents using tables to improve scannability.
- Add short descriptions for some of the missing sections.
- Fix broken links in intro.md
@deoxys94 deoxys94 force-pushed the mainPageRestructuring branch from 3db9968 to d7cc362 Compare February 2, 2024 08:06
@deoxys94
Copy link
Contributor Author

deoxys94 commented Feb 2, 2024

Hi @davidjharder,

I fixed the links and rebased the branch.

By the way, why software and package management are under docs/category/ instead of docs/user? The arrangement seems a little unusual.

@deoxys94 deoxys94 requested a review from davidjharder February 2, 2024 08:11
@davidjharder
Copy link
Member

By the way, why software and package management are under docs/category/ instead of docs/user? The arrangement seems a little unusual.

Yeah, it's weird. I don't know docusaurus well enough to do anything other than go along with it for now.

davidjharder
davidjharder approved these changes Feb 2, 2024
View reviewed changes
Copy link
Member

@davidjharder davidjharder left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks for your continued work on the help center

@davidjharder davidjharder merged commit a4db05e into getsolus:master Feb 2, 2024
1 check passed
@deoxys94 deoxys94 deleted the mainPageRestructuring branch February 4, 2024 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidjharder davidjharder davidjharder approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@deoxys94 @davidjharder