stacks-network / docs

Unleash Bitcoin's full potential with decentralized apps and smart contracts. The documentation covers key aspects of the Stacks network and technology and provides tutorials and other helpful content for developers.
https://docs.stacks.co
Creative Commons Zero v1.0 Universal
156 stars 235 forks source link

Initial content rewrite #1562

Closed kenrogers closed 1 year ago

kenrogers commented 1 year ago

Initial content rewrite for docs

vercel[bot] commented 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)
CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

wileyj commented 1 year ago

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.

wileyj commented 1 year ago

I would also like to see a dedicated section/page with more prominence given to the whitepapers

wileyj commented 1 year ago

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/

wileyj commented 1 year ago
Screenshot 2023-01-09 at 15 47 29

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"

satoshibles commented 1 year ago

Will we be adding this section back?

https://docs.stacks.co/docs/services-using-stacks/nft

Hero-Gamer commented 1 year ago

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"

Hero-Gamer commented 1 year ago

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.

Hero-Gamer commented 1 year ago

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 image Correct: performance

Incorrect: perfomance image Correct: performance

Incorrect: optionaly Correct: optionally

Hero-Gamer commented 1 year ago

https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/nodes-and-miners/digitalocean Incorrect: prefered Correct: preferred

Hero-Gamer commented 1 year ago

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.

wileyj commented 1 year ago

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?

kenrogers commented 1 year ago

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.

kenrogers commented 1 year ago

Will we be adding this section back?

https://docs.stacks.co/docs/services-using-stacks/nft

Yep, added this back in most recent push.

kenrogers commented 1 year ago

Everything in this PR has been addressed except for the Gaia/miner content, which will be addressed with future changes in the develop branch.

Hero-Gamer commented 1 year ago

https://stacks-docs-lcj697nen-stacks-team.vercel.app/docs/gaia/ Incorrect: immutabile Correct: immutable

Hero-Gamer commented 1 year ago

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.

image
Hero-Gamer commented 1 year ago

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

wileyj commented 1 year ago

@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

wileyj commented 1 year ago

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

Hero-Gamer commented 1 year ago

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.