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.

Sign up for GitHub

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

Jump to bottom

docs: link docs, refactor README.md #298

Merged
merged 3 commits into from
Oct 4, 2024
Merged

docs: link docs, refactor README.md #298

merged 3 commits into from
Oct 4, 2024

Conversation

mixmix
Copy link
Contributor

@mixmix mixmix commented Sep 29, 2024 •
edited
Loading

Fixes: #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

mixmix
mixmix commented Sep 29, 2024
View reviewed changes
yshyn-iohk
yshyn-iohk reviewed Sep 30, 2024
View reviewed changes
@mixmix mixmix changed the title link docs, refactor README.md DOCS: link docs, refactor README.md Sep 30, 2024
@mixmix mixmix changed the title DOCS: link docs, refactor README.md docs: link docs, refactor README.md Sep 30, 2024
@elribonazo
Copy link
Contributor

elribonazo commented Sep 30, 2024 •
edited
Loading

Beautiful

@coveralls
Copy link

coveralls commented Sep 30, 2024 •
edited
Loading

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 Coverage Status
Change from base Build 11072069144: 0.0%
Covered Lines: 3434
Relevant Lines: 4514
💛 - Coveralls

petevielhaber
petevielhaber reviewed Sep 30, 2024
View reviewed changes
@petevielhaber
Update README.md
100bd6b 
Signed-off-by: Pete Vielhaber <[email protected]>
petevielhaber
petevielhaber approved these changes Sep 30, 2024
View reviewed changes
Copy link
Contributor

@petevielhaber petevielhaber left a comment

Choose a reason for hiding this comment

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

  • Minor verbiage change

@mixmix
Copy link
Contributor Author

mixmix commented Sep 30, 2024

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

@elribonazo elribonazo merged commit 7b4542f into hyperledger-identus:main Oct 4, 2024
4 checks passed
elribonazo pushed a commit that referenced this pull request Oct 4, 2024
@mixmix @petevielhaber @elribonazo
docs: link docs, refactor README.md (#298)
083adb8 
Signed-off-by: mixmix <[email protected]>
Signed-off-by: Pete Vielhaber <[email protected]>
Co-authored-by: Pete Vielhaber <[email protected]>
@mixmix mixmix deleted the mixmix/link-docs branch October 10, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elribonazo elribonazo elribonazo left review comments

@yshyn-iohk yshyn-iohk yshyn-iohk left review comments

@petevielhaber petevielhaber petevielhaber approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Link to docs please!
5 participants
@mixmix @elribonazo @coveralls @petevielhaber @yshyn-iohk