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 - Develop - Organize Examples #1432

Merged
merged 35 commits into from
Sep 22, 2022
Merged

Docs - Develop - Organize Examples #1432

merged 35 commits into from
Sep 22, 2022

Conversation

lucas-tortora
Copy link
Contributor

@lucas-tortora lucas-tortora commented Sep 13, 2022 •
edited
Loading

Description of change

  • Organized examples by action rather than language
  • added expected outputs for each example and language
  • added getting started and how to run how tos
  • Added Admonitions
  • added explanations
  • updated api generation scripts
  • deleted unused files
  • improved python API generation

Links to any relevant issues

partially addresses iotaledger/iota-sdk#108
partially addresses #1258
partially addresses #1257

Type of change

  • Documentation Enhancement

How the change has been tested

The wiki and all examples were tested locally.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

Changes Outside the Docs Folder

  • Updated the package.json for the node,js binding so it generates the API ref in another location.
  • Updated the pydoc command to generated the API ref in another location.

Pending documentation tasks that should be tackled in another PR

Once these tasks are completed, we can add API ref to the examples.

API references

  • Check Node.js API reference for missing interfaces
  • Publish rust API reference

@lucas-tortora
* Organized examples by action rather than language
d5260aa 
* added expected outputs for each example and language
* added getting started and how to run how tos
*
* Added Admonitions
* added explanations
* updated api generation scripts
@lucas-tortora
renamed files as mdx
237b309 
updated python getting started to match develop
@lucas-tortora lucas-tortora marked this pull request as draft September 13, 2022 15:47
@lucas-tortora
* Organized examples by action rather than language
5755bcb 
* added expected outputs for each example and language
* added getting started and how to run how tos
*
* Added Admonitions
* added explanations
* updated api generation scripts
@lucas-tortora
renamed files as mdx
3752045 
updated python getting started to match develop
@lucas-tortora
fix conflicts
b045e74
@lucas-tortora
Merge remote-tracking branch 'origin/docs/organizeDocs' into docs/org…
7379d9a 
…anizeDocs
@lucas-tortora
dead links
9ee879b
@lucas-tortora lucas-tortora marked this pull request as ready for review September 13, 2022 15:57
lucas-tortora and others added 7 commits September 13, 2022 13:01
@lucas-tortora
dead links
4cc4e6f
@Thoralf-M @lucas-tortora
Add SeedSecretManager (iotaledger#1430)
2becd52
@lucas-tortora
* Organized examples by action rather than language
eceaf48 
* added expected outputs for each example and language
* added getting started and how to run how tos
*
* Added Admonitions
* added explanations
* updated api generation scripts
@lucas-tortora
renamed files as mdx
cc221bf 
updated python getting started to match develop
@lucas-tortora
rebase from origin develop, fix dead link
e451ce8
@lucas-tortora
added pydoc-markdown config.
16734d4 
added pydoc-markdown instructions in README.md
deleted old api reference
updated sidebar
added newly generated api reference
@lucas-tortora
resolve conflicts
e349279 
fix deade link in node api ref
@lucas-tortora
Copy link
Contributor Author

@aleksei-korolev , could you review this whenever you have a moment?

@lucas-tortora
Copy link
Contributor Author

@Thoralf-M , could you, or someone you see fit review this whenever you have a moment?

@lucas-tortora @Thoralf-M
Apply suggestions from code review from @Thoralf-M
81d37fa 
Co-authored-by: Thoralf-M <46689931+Thoralf-M@users.noreply.github.com>
thibault-martinez
thibault-martinez requested changes Sep 21, 2022
View reviewed changes
Copy link
Member

@thibault-martinez thibault-martinez left a comment

Choose a reason for hiding this comment

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

There are some conflicts

@Thoralf-M @lucas-tortora
Apply suggestions from code review
d5d6562 
Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com>
@lucas-tortora lucas-tortora requested review from thibault-martinez and removed request for Thoralf-M September 22, 2022 12:09
@Thoralf-M Thoralf-M merged commit 6809c1a into iotaledger:develop Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thibault-martinez thibault-martinez thibault-martinez approved these changes

@samuel-rufi samuel-rufi samuel-rufi approved these changes

@Thoralf-M Thoralf-M Thoralf-M 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.

None yet
4 participants
@lucas-tortora @thibault-martinez @samuel-rufi @Thoralf-M