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

Migrate the toml checker to Redocly (https://xrpl.org/xrp-ledger-toml-checker.html) #2274

Merged
merged 27 commits into from
Jan 3, 2024
Merged

Migrate the toml checker to Redocly (https://xrpl.org/xrp-ledger-toml-checker.html) #2274

merged 27 commits into from
Jan 3, 2024

Conversation

JST5000
Copy link
Contributor

@JST5000 JST5000 commented Nov 22, 2023 •
edited
Loading

This migrates this page: https://xrpl.org/xrp-ledger-toml-checker.html

It primarily involves migrating:

  1. xrpl-toml-checker.page.tsx
  2. xrp-ledger-toml-checker.js
  3. iarna-toml-parse.js
  4. (And moving over the test file xrp-ledger-toml-checker-test.js)

@JST5000 JST5000 marked this pull request as draft November 22, 2023 00:49
@socket-security Socket Security
Copy link

socket-security bot commented Nov 22, 2023 •
edited
Loading

New dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
smol-toml 1.1.3 None +0 71.3 kB cyyynthia

@github-actions GitHub Actions
Copy link

Link check report. 553607 links checked.
58 broken links found:
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-purple.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-green.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-orange.svg
File: out/xrp-overview.html Link: ./img/backgrounds/xrp-overview-blue.svg
File: out/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-magenta.svg
File: out/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-green-2.svg
File: out/history.html Link: ./img/backgrounds/history-orange.svg
File: out/history.html Link: ./img/backgrounds/history-purple.svg
File: out/impact.html Link: ./img/backgrounds/community-purple.svg
File: out/impact.html Link: ./img/backgrounds/home-green.svg
File: out/impact.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/impact.html Link: ./img/backgrounds/cta-calculator-green.svg
File: out/dev-tools.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/dev-tools.html Link: ./img/backgrounds/cta-home-green.svg
File: out/contribute.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/contribute.html Link: ./img/backgrounds/cta-community-green.svg
File: out/developer-funding.html Link: ./img/backgrounds/funding-purple.svg
File: out/developer-funding.html Link: ./img/backgrounds/funding-orange.svg
File: out/code-samples.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/index.html Link: ./img/backgrounds/home-purple.svg
File: out/index.html Link: ./img/backgrounds/home-green.svg
File: out/index.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/index.html Link: ./img/backgrounds/cta-home-green.svg
File: out/index.html Link: ./img/backgrounds/cta-home-magenta.svg
File: out/ambassadors.html Link: ./img/backgrounds/ambassador-purple.svg
File: out/docs.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/docs.html Link: ./img/backgrounds/cta-home-green.svg
File: out/events.html Link: ./img/backgrounds/events-orange.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-purple.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-green.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-orange.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/xrp-overview-blue.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-magenta.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-green-2.svg
File: out/ja/history.html Link: ./img/backgrounds/history-orange.svg
File: out/ja/history.html Link: ./img/backgrounds/history-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/community-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/home-green.svg
File: out/ja/impact.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/cta-calculator-green.svg
File: out/ja/dev-tools.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/dev-tools.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/contribute.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/ja/contribute.html Link: ./img/backgrounds/cta-community-green.svg
File: out/ja/developer-funding.html Link: ./img/backgrounds/funding-purple.svg
File: out/ja/developer-funding.html Link: ./img/backgrounds/funding-orange.svg
File: out/ja/code-samples.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/ja/index.html Link: ./img/backgrounds/home-purple.svg
File: out/ja/index.html Link: ./img/backgrounds/home-green.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-magenta.svg
File: out/ja/ambassadors.html Link: ./img/backgrounds/ambassador-purple.svg
File: out/ja/docs.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/docs.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/events.html Link: ./img/backgrounds/events-orange.svg

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/migrate-toml/

Style Report

1 similar comment
@github-actions GitHub Actions
Copy link

Link check report. 553607 links checked.
58 broken links found:
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-purple.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-green.svg
File: out/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-orange.svg
File: out/xrp-overview.html Link: ./img/backgrounds/xrp-overview-blue.svg
File: out/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-magenta.svg
File: out/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-green-2.svg
File: out/history.html Link: ./img/backgrounds/history-orange.svg
File: out/history.html Link: ./img/backgrounds/history-purple.svg
File: out/impact.html Link: ./img/backgrounds/community-purple.svg
File: out/impact.html Link: ./img/backgrounds/home-green.svg
File: out/impact.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/impact.html Link: ./img/backgrounds/cta-calculator-green.svg
File: out/dev-tools.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/dev-tools.html Link: ./img/backgrounds/cta-home-green.svg
File: out/contribute.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/contribute.html Link: ./img/backgrounds/cta-community-green.svg
File: out/developer-funding.html Link: ./img/backgrounds/funding-purple.svg
File: out/developer-funding.html Link: ./img/backgrounds/funding-orange.svg
File: out/code-samples.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/index.html Link: ./img/backgrounds/home-purple.svg
File: out/index.html Link: ./img/backgrounds/home-green.svg
File: out/index.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/index.html Link: ./img/backgrounds/cta-home-green.svg
File: out/index.html Link: ./img/backgrounds/cta-home-magenta.svg
File: out/ambassadors.html Link: ./img/backgrounds/ambassador-purple.svg
File: out/docs.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/docs.html Link: ./img/backgrounds/cta-home-green.svg
File: out/events.html Link: ./img/backgrounds/events-orange.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-purple.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-green.svg
File: out/ja/xrp-ledger-overview.html Link: ./img/backgrounds/cta-xrpl-overview-orange.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/xrp-overview-blue.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-magenta.svg
File: out/ja/xrp-overview.html Link: ./img/backgrounds/cta-xrp-overview-green-2.svg
File: out/ja/history.html Link: ./img/backgrounds/history-orange.svg
File: out/ja/history.html Link: ./img/backgrounds/history-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/community-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/home-green.svg
File: out/ja/impact.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/ja/impact.html Link: ./img/backgrounds/cta-calculator-green.svg
File: out/ja/dev-tools.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/dev-tools.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/contribute.html Link: ./img/backgrounds/cta-community-purple.svg
File: out/ja/contribute.html Link: ./img/backgrounds/cta-community-green.svg
File: out/ja/developer-funding.html Link: ./img/backgrounds/funding-purple.svg
File: out/ja/developer-funding.html Link: ./img/backgrounds/funding-orange.svg
File: out/ja/code-samples.html Link: ./img/backgrounds/xrpl-overview-orange.svg
File: out/ja/index.html Link: ./img/backgrounds/home-purple.svg
File: out/ja/index.html Link: ./img/backgrounds/home-green.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/index.html Link: ./img/backgrounds/cta-home-magenta.svg
File: out/ja/ambassadors.html Link: ./img/backgrounds/ambassador-purple.svg
File: out/ja/docs.html Link: ./img/backgrounds/cta-home-purple.svg
File: out/ja/docs.html Link: ./img/backgrounds/cta-home-green.svg
File: out/ja/events.html Link: ./img/backgrounds/events-orange.svg

Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/migrate-toml/

Style Report

@JST5000 JST5000 marked this pull request as ready for review December 5, 2023 01:02
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@XRPLF XRPLF deleted a comment from github-actions bot Dec 8, 2023
@mDuo13 mDuo13 added this to the Toolchain-Migration-Redocly milestone Dec 11, 2023
mDuo13
mDuo13 requested changes Dec 19, 2023
View reviewed changes
Copy link
Collaborator

@mDuo13 mDuo13 left a comment

Choose a reason for hiding this comment

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

  1. To match the location of the other tools, please put it under resources/dev-tools/.
  2. Modify the content/sidebars.yaml file to add the page: path/to/file.page.tsx line. You can skip the href line which doesn't actually do anything in my experience.
  3. I think there's some kind of error handling problem going on. Testing it on mduo13.com on leads to a blank result (with errors in the console). The tool should display the results especially if parsing the TOML or looking up the accounts didn't go well, since the point of this tool is to detect and point out problems.

content/dev-tools/toml-checker/ListTomlFields.tsx Outdated Show resolved Hide resolved
content/dev-tools/xrpl-toml-checker.page.tsx Outdated Show resolved Hide resolved
@XRPLF XRPLF deleted a comment from github-actions bot Jan 3, 2024
@XRPLF XRPLF deleted a comment from github-actions bot Jan 3, 2024
@JST5000
Copy link
Contributor Author

JST5000 commented Jan 3, 2024

  • To match the location of the other tools, please put it under resources/dev-tools/.
  • Modify the content/sidebars.yaml file to add the page: path/to/file.page.tsx line. You can skip the href line which doesn't actually do anything in my experience.
  • I think there's some kind of error handling problem going on. Testing it on mduo13.com on leads to a blank result (with errors in the console). The tool should display the results especially if parsing the TOML or looking up the accounts didn't go well, since the point of this tool is to detect and point out problems.

1st two are done, 3rd one I could not reproduce unfortunately.

@JST5000 JST5000 requested a review from mDuo13 January 3, 2024 21:56
@mDuo13 mDuo13 merged commit b07ff34 into redocly-migration Jan 3, 2024
2 of 3 checks passed
@XRPLF XRPLF deleted a comment from github-actions bot Jan 3, 2024
@mDuo13 mDuo13 deleted the migrate-toml branch January 3, 2024 22:17
@mDuo13
Copy link
Collaborator

mDuo13 commented Jan 3, 2024

Approved and merged with the same sidebar-related changes as #2270.

@XRPLF XRPLF deleted a comment from github-actions bot Jan 3, 2024
@XRPLF XRPLF deleted a comment from github-actions bot Jan 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ckniffen ckniffen Awaiting requested review from ckniffen

@pdp2121 pdp2121 Awaiting requested review from pdp2121

@mDuo13 mDuo13 Awaiting requested review from mDuo13

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Toolchain-Migration-Redocly
Development

Successfully merging this pull request may close these issues.
3 participants
@JST5000 @mDuo13 @ckniffen