Restructure sections #1535
Restructure sections #1535
Conversation
README.md
Outdated
| @@ -34,175 +34,3 @@ | |||
| | ✨ | **Reactive.** (Optional) [RxJS](https://github.com/ReactiveX/rxjs) API | | |||
| | 🔗 | **Relational.** Built on rock-solid [SQLite](https://www.sqlite.org) foundation | | |||
| | ⚠️ | **Static typing** with [Flow](https://flow.org) or [TypeScript](https://typescriptlang.org) | | |||
|
|
|||
There was a problem hiding this comment.
hmm, I'd like to keep README the way it was before - it's used on the GitHub page, not just on docs website
There was a problem hiding this comment.
Would it maybe make sense to create a separate file to have the shortened readme for the docs website and then have the readme reverted?
There was a problem hiding this comment.
hmm, I'm not sure yet. I worry this would be an extra maintenance burden to have to update both the main README and the docs
There was a problem hiding this comment.
ok I'll revert this change! Maybe someone can figure out a script to copy based off the sections. I tried asking around some forums and googling but to no avail ahha
| @@ -3,22 +3,33 @@ title: Contributing | |||
| hide_title: true | |||
There was a problem hiding this comment.
This should be made in CONTRIBUTING file, as this one simply mirrors it
There was a problem hiding this comment.
Do you mean I should make the changes only in the contributing file or in both? I'm assuming you mean both but I just want to make sure ahaha
There was a problem hiding this comment.
in CONTRIBUTING, yarn docs:dev does the update
There was a problem hiding this comment.
Do I need to run yarn docs:dev manually? When I run it manually, it errors out
There was a problem hiding this comment.
Try ./scripts/update-docusaurus. If doesn't work, what does it say?
There was a problem hiding this comment.
ohh I just realized it is probably is because I ran it on Windows. The error is '.\scripts\update-docusaurus' is not recognized as an internal or external command, operable program or batch file. I guess I'll just have to clone the repo on my Mac VM
|
@radex Updated with fixes |
|
thanks! |
As per described here: #1481 (comment)
I didn't add types as I don't use TypeScript and have no experience in it so I was worried about messing up haha