update documentation #23571
update documentation #23571
Conversation
Hey, I made some changes to the introduction text to improve fluency and made slight changes to the table design to make it easier to navigate through. hope you like it!
GiteaBot
added
the
lgtm/need 2
|
|
|
|
|
Maybe we can enforce this via markdownlint, but I guess some exceptions may be necessary. |
|
#23581 for the lint change. |
|
IIRC b is deprecated, and strong should be used for emphasis. That being said I'm unsure about these changes, and perhaps instead of a list we should list functionality in a different way. |
|
I've decided against this lint rule. It's to forbiding when one needs to use HTML to set HTML attributes like |
| blog post to read about the justification for a fork. | ||
|
|
||
| ## Purpose | ||
|
|
||
| The goal of this project is to provide the easiest, fastest, and most painless way of setting | ||
| up a self-hosted Git service. | ||
|
|
||
| With Go, this can be done platform-independently across | ||
| **all platforms** which Go supports, including Linux, macOS, and Windows, | ||
| This is possible with Go, it is platform-independent and supports **all platforms**, including Linux, macOS, and Windows, |
There was a problem hiding this comment.
This is different from the previous statement. Gitea should work on all platforms that Go supports, but Go doesn't support "all" platforms.
There was a problem hiding this comment.
Indeed. Go for example does not support Solaris 😉
There was a problem hiding this comment.
Indeed. Go for example does not support Solaris 😉
It should support Solaris on amd64 arch.
https://go.dev/doc/install/source#environment
| @@ -11,22 +11,21 @@ draft: false | |||
| # What is Gitea? | |||
|
|
|||
| Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. | |||
| Gitea is a fork of [Gogs](http://gogs.io). See the [Gitea Announcement](https://blog.gitea.io/2016/12/welcome-to-gitea/) | |||
| Gitea is a fork of repository named [Gogs](http://gogs.io). Kindly check out the [Gitea Announcement](https://blog.gitea.io/2016/12/welcome-to-gitea/) | |||
There was a problem hiding this comment.
While it's also true that the Gitea repo is a fork of the Gogs repo, the previous statement makes more sense imo, that the Gitea project is a fork of the Gogs project, or "Gitea is a fork of Gogs".
I do like the change to the next sentence, though. 🙂
There was a problem hiding this comment.
ohkk....thank you for considering 😀
|
Thanks for your PR. I'm going to close it due to the comments above. If you'd like to contribute again, please hop into chat and we'd be happy to be able to help out :) |
Hey, I made some changes to the introduction text to improve fluency and made slight changes to the table design to make it easier to navigate through.
hope you like it!