documents sort #83
documents sort #83
Conversation
|
@Oliver-Quail,Thank you for your review |
Oliver-Quail
left a comment
Oliver-Quail
left a comment
There was a problem hiding this comment.
Firstly, great PR.
This really improves what was already there. Please fix the broken links and check if mingw64 can be used as well.
Once that is done I will be happy to approve this PR
| @@ -0,0 +1 @@ | |||
| contributors:Haoyu Liu,Runqi Liu.Wei Zhang | |||
There was a problem hiding this comment.
Minor thing, I would change this to "documentation contributors"
docs/feature/clang-format/README.md
Outdated
|
|
||
| + Install the [SplashKit](https://splashkit.io) SDK using the [guide](https://splashkit.io/articles/installation/) | ||
|
|
||
| ## Pre-requisites (mingw32 / Windows) |
There was a problem hiding this comment.
I would suggest changing this to Windows with mingw32 or mingw64. Unless there is some reason not to use the 64 bit version?
docs/feature/clang-format/README.md
Outdated
| + Run the application ```./test``` | ||
|
|
||
| ## Contributing code and running the code formatter | ||
| Have a read of [CONTRIBUTING.md](CONTRIBUTING.md) to see the general code style conventions followed throughout the project. |
There was a problem hiding this comment.
Link is broken. It should be:
../../../CONTRIBUTING.md
|
|
||
| + Install the [SplashKit](https://splashkit.io) SDK using the [guide](https://splashkit.io/articles/installation/) | ||
|
|
||
| ## Pre-requisites (mingw32 / Windows) |
There was a problem hiding this comment.
Again, please see the previous comment with regards to this point previously
docs/huy-pham/README.md
Outdated
|
|
||
| + Install the [SplashKit](https://splashkit.io) SDK using the [guide](https://splashkit.io/articles/installation/) | ||
|
|
||
| ## Pre-requisites (mingw32 / Windows) |
There was a problem hiding this comment.
Again, please see the previous comment with regards to this point previously
There was a problem hiding this comment.
Another thing with this file, in future, please can you change the name to a more descriptive name. This is probably something you should do in the next PR.
docs/main/README.md
Outdated
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions to improve Arcade Machine and make it even better! If you’re interested in contributing, please review our guidelines in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. Contributions can include bug fixes, new features, documentation improvements, or general enhancements. We appreciate your support in making Arcade Machine a great experience for all users! |
There was a problem hiding this comment.
Again broken link. It should be ../../CONTRIBUTING.md
…thback777/arcade-machine into docs/arcrade-consolidation
Oliver-Quail
left a comment
Oliver-Quail
left a comment
There was a problem hiding this comment.
Hi team,
I can see the requested changes have been made. I approve this PR
4 participants
Integrate all explanatory documents into the "docs" folder