Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

fix: improve styling and performance for interactive docs #4033

Merged
merged 95 commits into from
Mar 10, 2023

Conversation

MicaiahReid
Copy link
Contributor

@MicaiahReid MicaiahReid commented Dec 14, 2022

This PR:

  • fixes the slow rendering issues of the current interactive docs by lazy-loading the monaco windows as you scroll
  • fixes some bits of buggy UI/UX
  • fixes all examples from api.ts
  • fixes links to source code (they now point to code at commit hash that generated docs [note, in development you'll have to push your changes for these links to work])
  • adds color theme switcher
  • adds themes to monaco editor to allow ganache styling
  • borrows heavily from @OnlyOneJMJQ's PR for styling (docs: restyle docs to be more "Truffley" #4035)
  • improves rendering consistency for users with JS disabled
  • groups RPC methods and orders groups in a way that makes sens
  • lazy loads ganache
  • probably some other stuff

Known Issues:

  • arguments list is one string, returns are split on colon
  • non-primitive types, like Transaction, DATA, QUANTITY, etc aren't documented
  • TypeScript types for the ganache provider is not loaded into the editors
  • The console and assert helpers in the editors are incomplete implementations (and lack types)

@davidmurdoch davidmurdoch temporarily deployed to github-pages March 1, 2023 22:30 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch temporarily deployed to github-pages March 7, 2023 20:55 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch temporarily deployed to github-pages March 7, 2023 22:03 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch temporarily deployed to github-pages March 7, 2023 22:41 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch temporarily deployed to github-pages March 9, 2023 15:37 — with GitHub Pages Inactive
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 9, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: c80c979
Status: ✅  Deploy successful!
Preview URL: https://43bfe1fa.ganache.pages.dev

View logs

@davidmurdoch davidmurdoch temporarily deployed to github-pages March 9, 2023 15:48 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch temporarily deployed to github-pages March 9, 2023 15:56 — with GitHub Pages Inactive
@davidmurdoch davidmurdoch changed the title docs: fix styling and performance for interactive docs fix: fix styling and performance for interactive docs Mar 9, 2023
@davidmurdoch davidmurdoch changed the title fix: fix styling and performance for interactive docs fix: improve styling and performance for interactive docs Mar 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants