feat: update specs and documentation #16
Conversation
martinheidegger
force-pushed
the
deep-docs
branch
from
c66e9f6
to
0db353f
Compare
This comment has been minimized.
This comment has been minimized.
martinheidegger
force-pushed
the
deep-docs
branch
from
3271815
to
216eb96
Compare
There was a problem hiding this comment.
Thank you @martinheidegger
I reviewed and applied some feedback / changes based on asks from https://github.com/dnslink-std/test/issues/ so it is easier for you to update
docs/README.md
Outdated
|
|
||
| ``` | ||
| dnslink=<value> | ||
| dnslink=/ipfs/QmaCveU7uyVKUSczmiCc85N7jtdZuBoKMrmcHbnnP26DCx |
There was a problem hiding this comment.
This CID can be GCd by Fleek at some point.
Please use a stable CID for examples, such as Wikipedia one (bafybeiaysi4s6lnjev27ln5icwm6tueaw2vdykrtjkwiphwekaywqhcjze – see snapshot-hashes.yml)
|
@martinheidegger sadly this got out of sync with changes to the In effort to clean up things a bit, I merged |
|
@martinheidegger lmk if/when this is ready for another review 🙏 |
|
Yes, I am crunching on a deadline atm. I will update this issue within this
week.
…On Wed, 29 Jun 2022 at 05:06, Marcin Rataj ***@***.***> wrote:
@martinheidegger <https://github.com/martinheidegger> lmk if/when this is
ready for another review 🙏
—
Reply to this email directly, view it on GitHub
<#16 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAG7FSQ3SDXHZBHLM6K7UPTVRNLN7ANCNFSM5AS3WWSA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
martinheidegger
force-pushed
the
deep-docs
branch
2 times, most recently
from
99bf808
to
4b58e8a
Compare
|
I went over the entire documentation once more. The current docs should contain all of your suggestions, are rebased to the current main but also are:
|
|
Ah, this PR adds information about multiple DNSLinks and multiple DNSLinks in the same namespace. That is what I needed. Thanks. |
lidel
changed the title
Co-authored-by: Marcin Rataj <[email protected]> [07d9a39] [f11f8bd] [62fe9d8] [e7481ce] [7b4c7d8] [015eca3] [3df008a] [a4768c2] [453a29c] [67d6aa1] [6a79a0a] [a683ccc] [23efa9c] [65a43ef] [e05bea0] [7ab4bad] [bdd2899] (+2 squashed commits) Squashed commits: [6239f46] docs: adding mention on redirect ttl's [40efd8e] Adding thorough documentation of the new details covered in the test suite
…to keep normalized language, brevity and 80~100 characters per line
Updated content to reflect changes since 2021: - go-ipfs got renamed to Kubo, ipfs.io websites moved to ipfs.tech - Cloudflare and Fleek provide turn-key website hosting solutions - Gateway docs and resources got updated and changed links - DNSLink is not limited to DWeb, adjusted language and added best practices around supporting multiple protocol records Added some references: - mentioned convention from RFC 1464 (<key>=<value>) - due to this, clarified that prefix is `dnslink=` and not `dnslink=/` and why value should start with `/namespace/` prefix Fixed small typos and removed line numbers from code blocks.
There was a problem hiding this comment.
Thank you @martinheidegger, I'm merging this so it does not slip between notification cracks again 🙈
FYI I made some edits to reflect changes since 2021:
- go-ipfs got renamed to Kubo, ipfs.io websites moved to ipfs.tech
- Cloudflare and Fleek provide turn-key website hosting solutions
- Gateway docs and resources got updated and changed links
- DNSLink is not limited to DWeb, adjusted language and added best
practices around supporting multiple protocol records
Added some references:
- mentioned convention from RFC 1464 (=)
- due to this, clarified that prefix is
dnslink=and notdnslink=/
and why value should start with/namespace/prefix
Fixed small typos and removed line numbers from code blocks.
The new test suite for DNSLink covers quite a few new topics.
Note: The PR is set against the
nextbranch. This is to prevent the immediate publication of the docs and allows us to publish the next version of DNSLink in one go as I will need to send a few more Pull Requests for updating other sections of the readme and links to the new libraries.