Closed kenrogers closed 1 year ago
The latest updates on your projects. Learn more about Vercel for Git ↗︎
Name | Status | Preview | Updated |
---|---|---|---|
stacks-docs | ✅ Ready (Inspect) | Visit Preview | Jan 13, 2023 at 9:12PM (UTC) |
Most everything looks good to me - i didn't see any glaring issues in the code/markdown, just a few suggestions and questions.
One thing to note - i changed the dest branch to develop
, we can merge this and then update some incorrect docs i noted in the current docs data.
I would also like to see a dedicated section/page with more prominence given to the whitepapers
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/nodes-and-miners/miner-costs-and-fees
I think we should add a link to friedgers cost tool here - https://friedger.id/mining-calculator/
Not a huge fan of how cluttered this top bar looks. do we need all of these at the top, or could they be given higher prominence on the landing page perhaps?
Likewise, "Stacks Documentation" and the link next to it "Docs" are identical and redundant. i'd remove the "Docs" link entirely, and rename "Stacks Documentation" to simply "Stacks"
Will we be adding this section back?
I can't find the content under "files changed" tab for this page: https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/stacks-academy/sips
Error on this page is on line SIP 004, the word "Committment" is spelled wrong, should be "Commitment"
again, can't find the text from this page https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/stacks-academy/microblocks under the Files Changed tab.
under Enabling microblocks Miners can choose to enable or disable microblocks in their mining configuration. As a best practice, miners should enable microblock mining.
that last microblock word should be plural I think, therefore should say microblocks
whole paragraph should say: Enabling microblocks Miners can choose to enable or disable microblocks in their mining configuration. As a best practice, miners should enable microblocks mining.
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/nodes-and-miners/run-a-node Under the sub-page: run-a-node with DOCKER
Incorrect: prefered Correct: preferred
Possible incorrect: Vcpu Possible correct: cpu
Incorrect: perfomance
Correct: performance
Incorrect: perfomance
Correct: performance
Incorrect: optionaly Correct: optionally
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/nodes-and-miners/digitalocean Incorrect: prefered Correct: preferred
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/nodes-and-miners/miner-mainnet Incorrect: crytpocurrency Correct: cryptocurrency
There are 6 same error / occurrences on this page.
ping @kenrogers if you need help, maybe add myself and a few others here as collaborators on your branch so we can get these corrections resolved?
ping @kenrogers if you need help, maybe add myself and a few others here as collaborators on your branch so we can get these corrections resolved?
Going through and addressing all these today. I also added a spell check extension in VS Code and will be running that through all files to hopefully eliminate that issue. Will add you and Hero as collaborators after my initial sweep today so we don't end up with conflicts on this initial batch of fixes.
Will we be adding this section back?
Yep, added this back in most recent push.
Everything in this PR has been addressed except for the Gaia/miner content, which will be addressed with future changes in the develop
branch.
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/gaia/ Incorrect: immutabile Correct: immutable
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/contribute/#articles More of a visual/functional comment: The links that only appears when you hover cursor over felt little strange and pointless? I'm not sure the purpose of it without further context, just flagging.
https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/contribute/docs (Some of which below may already been commented already, some may not have)
Incorrect:docs reposiroty Correct: docs repository
Incorrect: so you can see a preview of yourhanges in real time. Correct: so you can see a preview of your changes in real time.
Incorrect: Aditional information Correct: Additional information
Incorrect: alterative Correct: alternative
@kenrogers once you resolve the conflicts, let's merge this. @Hero-Gamer please hold off on any new comments until we can get the changes into this repo where we can all make changes as needed vs putting it all on Ken
merge into https://github.com/stacks-network/docs/tree/develop.
I'll open a PR for develop-> master so we can continue the updates there
I finished commenting all good! I checked all pages I think :P Good luck let me know if you need a second run through or other help.
Initial content rewrite for docs