Skip to content

Readme clean-up #2063

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
merged 2 commits into from
Oct 8, 2025
Merged

Readme clean-up #2063

merged 2 commits into from
Oct 8, 2025
+293 −428

Conversation

@spacez320
Copy link
Contributor

@spacez320 spacez320 commented Sep 22, 2025 •
edited
Loading

The main goal here is to run through the entire Readme and try to make it more succinct and understandable.

In general the changes try to:

  • remove redundant information
  • clarify vague information
  • prefer showing code over explanations
  • remove lists of functions and other details that are better read from Go docs
  • shorten sentences and try to get to the point more quickly

After doing this, I will move on to #2006 and will also spend time making sure the code examples are accurate.
sagikazarmark
sagikazarmark reviewed Sep 26, 2025
View reviewed changes
Copy link
Collaborator

@sagikazarmark sagikazarmark left a comment

Choose a reason for hiding this comment

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

Thanks @spacez320

I'm not saying I read through all of it, but what I've read looks goot to me.

I had to minor comments
@spacez320
Copy link
Contributor Author

/label docs
@spacez320
Copy link
Contributor Author

/label area/documentation
@sagikazarmark sagikazarmark added kind/enhancement New feature or request area/documentation Improvements or additions to documentation labels Oct 8, 2025
sagikazarmark
sagikazarmark reviewed Oct 8, 2025
View reviewed changes
README.md
```

**Note:** Viper uses [Go Modules](https://go.dev/wiki/Modules) to manage dependencies.
> **NOTE** Viper uses [Go Modules](https://go.dev/wiki/Modules) to manage dependencies.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We could use the new highlight feature: https://github.com/orgs/community/discussions/16925
sagikazarmark
sagikazarmark approved these changes Oct 8, 2025
View reviewed changes
Copy link
Collaborator

@sagikazarmark sagikazarmark left a comment

Choose a reason for hiding this comment

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

Thanks a lot!
@sagikazarmark sagikazarmark merged commit c0965a2 into spf13:master Oct 8, 2025
35 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation kind/enhancement New feature or request

2 participants

@spacez320 @sagikazarmark