Skip to content
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

feat: docs in website! #5

Merged
merged 4 commits into from
Nov 13, 2023
Merged

feat: docs in website! #5

merged 4 commits into from
Nov 13, 2023

Conversation

olizilla
Copy link
Contributor

merge the docs repo into the website at /docs.

doing this at deploy time proved tricky, so now we just build all the things together.

markdown files can be added directly to src/pages/docs/your-topic-here.md and add it to a _meta.json at the same level to set it's link title and position in the nav.

License: MIT

Copy link
Contributor

github-actions bot commented Nov 10, 2023

merge the docs repo into the website at /docs.

doing this at deploy time proved tricky, so now we just build all the things together.

markdown files can be added directly to `src/pages/docs/your-topic-here.md` and add it to a `_meta.json` at the same level to set it's link title and position in the nav.

License: MIT
Signed-off-by: Oli Evans <[email protected]>
Comment on lines +85 to +92
```js
const files = [
new File(['some-file-content'], 'readme.md'),
new File(['import foo'], 'src/main.py'),
new File([someBinaryData], 'images/example.png')
]

const directoryCid = await client.storeDirectory(files)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be worth to put here a small Node.js code snippet :)

└── src
└── main.py
```
## View your file on an IPFS gateway
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have a similar section in cli. Should we just point both to a different page for IPFS Gateway?


Note that the `w3 delegation create` command we used in step 5 delegates the `'*'` or "top" capability by default, so the second agent will have full access to the space. You can restrict the set of delegated capabilites using the `--can` flag. Try running `w3 delegation create --help` to see more options.

## Wrapping up
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we have a few other resources that we could reference here that cover how UCANs work and practical system implementations:

  • ucantoo workshop talk/video in Lisbon
  • Where is my CAR talk in Fil dev summit

@olizilla olizilla merged commit 484e0c1 into main Nov 13, 2023
@olizilla olizilla deleted the docs branch November 13, 2023 09:29
olizilla pushed a commit that referenced this pull request Nov 14, 2023
🤖 I have created a release *beep* *boop*
---


## 1.0.0 (2023-11-14)


### Features

* add banner linking to old site
([1fd9a44](1fd9a44))
* add specs link to sidebar
([#11](#11))
([ab2f048](ab2f048))
* adds pricing and features pages
([#4](#4))
([962cf3d](962cf3d))
* bones of the homepage 🦴
([bb7905e](bb7905e))
* docs in website! ([#5](#5))
([484e0c1](484e0c1))
* homepage gets nicer
([#1](#1))
([bd5fae8](bd5fae8))
* lint md in ci with remark
([#9](#9))
([22328cd](22328cd))
* pink first website header.
([#18](#18))
([37c7052](37c7052))
* price plans ([#6](#6))
([cefc492](cefc492))


### Bug Fixes

* broken links and copy
([#19](#19))
([c268748](c268748))
* rename plan from free to starter
([#16](#16))
([eb5b73e](eb5b73e))
* update footer links
([#14](#14))
([7f2ac1e](7f2ac1e))
* update meta for created and merged docs page
([#17](#17))
([c99f62c](c99f62c))


### Other Changes

* deploy website from CI
([#2](#2))
([4952aa2](4952aa2))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants