-
-
Notifications
You must be signed in to change notification settings - Fork 342
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.
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
fix(docs): Grammatical Error correction #105
fix(docs): Grammatical Error correction #105
Conversation
Someone is attempting to deploy a commit to a Personal Account owned by @kimlimjustin on Vercel. @kimlimjustin first needs to authorize it. |
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/kimlimjustin/xplorer/27F28HjgsQ993vL4om1V4sezjKzk |
And, the docs will be hosted on GitHub Pages, and don't worry, I have a plan to push it there whenever the docs or the entire repo is updated. I will make a GitHub Action where it will deploy the webpage on push and exactly two and a half minutes later, it will be up. Favicons are supported, and you can add buttons, customize themes, and build the webpage immediately too. Extra note: CODEDOC has its own CLI and you can get the boilerplate theme from there, but you can actually use NPM to get dependencies. |
Ah, everything is successful! More correction and I will release this for review. |
For the CODECOC, is it based on React? What I mean with buggy is that when I build it (production), the link is broken (you can see the electron link on the main page there) and I opened a PR there and they said it's probably because of React, so ...... Also, tbh, the Docusaurus website is more elegant tho... |
CODEDOC is built around TSX and TS but you use Markdown for the documentation. |
The problem is if I use it as documentation, it surely has to be styled, which is an effort... |
Sorry for that, I was using my phone and now switched to laptop(the phone
didn't get synced), you don't need to switch styles, just get the hex code
and put it in the themes file(typescript)
|
Maybe I can help in the styling. Since I learnt what files are supposed to be configured, I can set a specific color for the button and another for the themes, etc. |
I don't think Ill change it into CODECOC since yeah the UX is quite annoying (at least for me), if you are saying about changing to next js, I might consider it, thanks tho Also, Im not talking only the color, the sidebar is a bad choice tho |
oh yeah @kimlimjustin I found some kind of error with Algoria, it does show search results but doesn't open the respective pages, is this internal or external? |
Its problem with algolia (the docs is always being updated tho, maybe algolia hasn't crawl it(?)) |
Hey @kimlimjustin the PR is ready. You have a failing workflow in build and it is due to a token, so can you try fixing it soon? |
Fixed it via 469633c |
Motivation
I observed that the docs have a lot of grammatical errors so I am aiming to fix it through this PR
Changes
Almost every single file in the documentation(mostly the important ones)
Related
Nothing related here as of now.
Additional Comments
I could finish everything in a week since the docs have a lot of files, I need to go through them when I am free, and I have a genuine suggestion: Last time, you said that Docusaurus is buggy sometimes, so why not use CODEDOC? CODEDOC is another documentation source like Docusaurus and everything there is really minimal. You get a footer, where you can link your repository, add starring buttons, link a Gitter community(if you want) and create custom components from TypeScript. So, if you want to switch, you can ask me anytime. Documentation of CODEDOC is over on https://codedoc.cc and yeah, it doesn't work with Vercel but with GitHub Pages, and I have an idea for that 😉