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

Update documentation #1604

Open
wants to merge 9 commits into
base: feat/identity-rebased-alpha
Choose a base branch
from
Open

Conversation

wulfraem
Copy link
Contributor

@wulfraem wulfraem commented Mar 11, 2025

Description of change

Updates and refactors documentation update are related to iotaledger/iota#4183 in iota repository.

Documentation has been deduplicated and explanations have mostly been moved from Readme to identity docs.

Some parts of the example have been updated to make examples have a matching flow for both languages to fit better to the wiki explanation.

Type of change

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

- banner url
- update wasm example code
- align with wiki
- align root readme with rust readme
- deduplicate parts between wiki and readmes
- fix smaller typos
- remove test package IDs
@wulfraem wulfraem added the No changelog Excludes PR from becoming part of any changelog label Mar 11, 2025
@wulfraem wulfraem requested a review from a team as a code owner March 11, 2025 11:15
@@ -13,7 +13,7 @@ Examples can be run against
- or an existing network, e.g. the IOTA testnet

When setting up the local node, you'll also need to publish an identity package as described in
[Getting Started](../../../../README.md#getting-started).
[Local Network Setup](https://docs.iota.org/iota-identity/getting-started/local-network-setup) in the wiki.
Copy link
Collaborator

Choose a reason for hiding this comment

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

since we point to the docs for this content, should we remove it from the repo?

Copy link
Collaborator

@eike-hass eike-hass left a comment

Choose a reason for hiding this comment

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

LGTM with the nit for the local setup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No changelog Excludes PR from becoming part of any changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants