ipfs-docs
ipfs-docs copied to clipboard
Basics of JS-IPFS
Closes #1207
- adds steps as proposed in issue. leaves out the more interactive pieces (such as dialog and input box)
- proposes the use of tabs: using an external plugin which can be changed
- modifies and updates JS content
Thank you for submitting this PR! A maintainer will be here shortly to review it. We are super grateful, but we are also overloaded! Help us by making sure that:
- The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
- Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.
Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment. Next steps:
- A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
- The PR gets reviews, discussed and approvals as needed.
- The PR is merged by maintainers when it has been approved and comments addressed.
We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution. We are very grateful for your contribution!
This looks fun! There's some weird stuff going on with the tabs though. Clicking on one of the tabs under Install JS-IPFS jumps me down to the next section:
https://user-images.githubusercontent.com/9611008/182938261-933057c8-89ac-4e82-b154-8c2c07a7d450.mov
It looks like that tabs plugin you used has been abandoned. I'm trying out https://github.com/Kaifuny/vuepress-plugin-tabs instead. Gonna convert this PR to a draft since I'm working on it.
Made a few changes to the formatting and copy. I also fixed the tab problem we hit earlier.
Just a few notes @DannyS03:
-
When listing steps, us an ordered list:
Lorem ipsum: 1. First do this. 1. Then do that. 1. Finally, do this other thing. -
Use markdown syntax for images:
 -
Try and use 4 spaces when indenting. The markdown parser specifically looks for 4 spaces, not 2.
1. You should obtain an output similar to: ```shell Added file: test.txt CID(QmYt9ypyGsR1BKdaCGPdwdBgAiuXK5AYN2bGSNZov7YXuk) ``` 1. More steps. 1. Even more steps.
There's also a few TODOs sprinkled through the js-ipfs.md file. Ping me again when you've addressed those.
@johnnymatthews addressed
With the tabs addition added, will create an issue after this is merged to propose a similar approach for kubo basics
Deploy Preview for neon-choux-85b010 failed.
| Name | Link |
|---|---|
| Latest commit | 3760590acf367379024312401ca064db70a699c5 |
| Latest deploy log | https://app.netlify.com/sites/neon-choux-85b010/deploys/63151b409b67110008a2caae |