Closed pawartur closed 2 years ago
### Description Originated from @oed 's remark ([https://discord.com/channels/484729862368526356/880367090371035206/1012696591045509160](https://discord.com/channels/484729862368526356/880367090371035206/1012696591045509160)) : > **@artur.wdowiarski🔸** do you know why the readme of the dids pkg is not being populated in the API docs? > > Info from readme: [https://did.js.org/docs/api/modules/did_session](https://did.js.org/docs/api/modules/did_session) > > No info from readme: [https://did.js.org/docs/api/modules/dids](https://did.js.org/docs/api/modules/dids) #
Thanks, @PaulLeCam !
Yes, the contents was copied from dids
' README. One notable difference is that I removed the link to online docs from index.ts
, as we will be generating the same online docs from this file in the first place.
The wrong link in website/docs/api/modules/dids.md
that you commented on was there, because I didn't rebuild the docs after removing the link from the index.ts
file.
I hope all is good now.
Description
Updated the inline docs to include the examples and security considerations that were previously only in README.
The contents of the inline docs will also be used for the automated generation of the https://did.js.org/docs/api/modules/dids page.
How Has This Been Tested?
Describe the tests that you ran to verify your changes. Provide instructions for reproduction.
Definition of Done
Before submitting this PR, please make sure: