docs: link docs, refactor README.md

hyperledger / identus-edge-agent-sdk-ts

Apache License 2.0

24 stars 13 forks source link

docs: link docs, refactor README.md #298

Closed mixmix closed 1 month ago

mixmix commented 1 month ago

Fixes: https://github.com/hyperledger/identus-edge-agent-sdk-ts/issues/295

This PR is designed to make the docs more accessible

link to docs website
group the headings hierarchically more clearly
simplify the headings
- less words
- consistent labels (demo everywhere not demo/sample)
remove filler text

elribonazo commented 1 month ago

Beautiful

coveralls commented 1 month ago

Pull Request Test Coverage Report for Build 11105307355

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 72.788%

Totals
Change from base Build 11072069144:	0.0%
Covered Lines:	3434
Relevant Lines:	4514

💛 - Coveralls

mixmix commented 1 month ago

Process question: who pushes merge and when?

In projects I've worked on when it's all green, it gets merged. Obviously there is some process that is different here, but I don't know what it is? I've been thinking it might be nice to add something to CONTRIBUTING.md to explain