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

docs: Proofread Standards docs #1668

Merged
merged 23 commits into from
Aug 13, 2024

Conversation

PhilippGackstatter
Copy link

@PhilippGackstatter PhilippGackstatter commented Aug 7, 2024

Description of change

Proofread Standards section in the docs.

  • Fix various typos.
  • Convert tabs to spaces (because tabs have a different indentation on the rendered page).
  • Add missing PTB examples, mostly in the kiosk doc.
  • References to Sui projects have been removed or adapted.
  • The tooling team told me that @iota/wallet-standard is a package that will be published, so the Wallet Standard page should be correct as-is once the wiki goes public.
  • I double-checked the syntax of the JavaScript and Rust examples and fixed them if they were broken.
  • All struct definition examples in Move were made public since structs must always be public and the examples should be syntactically correct. Unnecessary imports were also removed and some occurrences were rewritten to method-style syntax.

Links to any relevant issues

fixes #1293

@PhilippGackstatter PhilippGackstatter added the vm-language Issues related to the VM & Language Team label Aug 7, 2024
@PhilippGackstatter PhilippGackstatter changed the title docs: Proof-read _Standards_ docs docs: Proofread Standards docs Aug 7, 2024
@PhilippGackstatter PhilippGackstatter marked this pull request as ready for review August 8, 2024 13:41
@PhilippGackstatter PhilippGackstatter requested a review from a team as a code owner August 8, 2024 13:41
Copy link
Contributor

github-actions bot commented Aug 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Aug 9, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

github-actions bot commented Aug 9, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Member

@lzpap lzpap left a comment

Choose a reason for hiding this comment

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

It's a nit, but let's put the Overview page on the header of Standards. like we did it here 4681b24

@PhilippGackstatter
Copy link
Author

It's a nit, but let's put the Overview page on the header of Standards. like we did it here 4681b24

Okay, I think I did what you wanted, but not 100% sure I understood correctly 😅

Copy link
Contributor

@valeriyr valeriyr left a comment

Choose a reason for hiding this comment

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

@PhilippGackstatter well done! Just left several minor comments.

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

@Dr-Electron Dr-Electron left a comment

Choose a reason for hiding this comment

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

Suggested a better way to autogenerate index pages.

This is also the reason why we need description frontmatter everywhere, because then it gets added to the cards in the index page

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@PhilippGackstatter PhilippGackstatter merged commit 2d52a43 into develop Aug 13, 2024
33 of 34 checks passed
@PhilippGackstatter PhilippGackstatter deleted the vm-language/feat/standards-docs-updates branch August 13, 2024 14:17
bingyanglin pushed a commit that referenced this pull request Aug 19, 2024
* fix(docs): Typos in Standards section

* fix(docs): Fix typos and broken links in coin docs

* fix(docs): Typos in CoinManager doc

* feat(docs): Add missing PTBs to kiosk docs

* fix(docs): Typos in kiosk apps

* fix(docs): Fix typos and consistency

* fix(docs): Convert tabs to spaces

* fix(docs): Typos in wallet standard

* fix(docs): JavaScript examples

* fix(docs): Make Move examples syntactically correct

* fix(docs): Put overview on Standards header

* fix(docs): update link to Standards in developer documentation

* Update docs/content/sidebars/developer.js

Co-authored-by: Dr-Electron <[email protected]>

* fix(docs): Auto generate standards overview

* fix(docs): More move warning fixes

* fix(docs): Use `programmable_move_call` instead of command

---------

Co-authored-by: Thibault Martinez <[email protected]>
Co-authored-by: Dr-Electron <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
vm-language Issues related to the VM & Language Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task (Docs)] Proof-read Standards under Developers, check examples
8 participants