8000 Added docs generator by mfbz · Pull Request #2429 · onflow/fcl-js · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Added docs generator #2429

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

Draft
wants to merge 107 commits into
base: master
Choose a base branch
from
Draft

Added docs generator #2429

wants to merge 107 commits into from

Conversation

mfbz
Copy link
Contributor
@mfbz mfbz commented May 19, 2025

Closes #2390

Added a folder called docs-generator containing scripts to generate documentation for the onflow/docs repo from packages codebase.

@mfbz mfbz marked this pull request as draft June 11, 2025 22:00
@jribbink
Copy link
Contributor
jribbink commented Jun 19, 2025

Can we please add the import statement to the types page?

e.g. for type Account show import is import {type Account} from "@onflow/sdk"

mfbz and others added 13 commits June 19, 2025 12:07
* Added core types export (#2437)

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored fcl-core current-user folder files to TypeScript (#2454)

* Refactored current-user folder with corresponding type definitions

* Renamed CurrentUserFull to CurrentUserService

* Improved CurrentUser interface

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored root files (#2479)

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored serialize folder (#2476)

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored fcl-core document folder files to TypeScript (#2464)

* Refactored document folder

* Update packages/fcl-core/src/document/document.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Refactored fcl-core utils folder files to TypeScript (#2477)

* Refactored utils folder

* Update packages/fcl-core/src/utils/chain-id/chain-id-watcher.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/utils/chain-id/chain-id-watcher.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Fixed minor typo

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Refactored fcl-core events folder files to TypeScript  (#2472)

* Refactored legacy events file

* Fixed for compatibility

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored fcl-core app utils folder files to TypeScript (#2442)

* Refactored app-utils folder

* Added new types export

* Update packages/fcl-core/src/fcl-core.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Cleaned up any usage

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Refactored fcl-core exec folder files to TypeScript (#2473)

* Completed exec folder refactoring

* Substituted correct current-user usage

* Improved mutate options interface

* Cleanup any usage

* Refactored any usage to only when needed

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored fcl-core discovery folder files to TypeScript (#2462)

* Refactored discovery folder

* Reused ActorContext from util-actor package

* Minor fix

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Refactored fcl-core wallet-utils folder files to TypeScript (#2478)

* Refactored wallet-utils folder

* Made account proof data optional

* Update packages/fcl-core/src/wallet-utils/encode-account-proof.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/encode-account-proof.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/encode-account-proof.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Improved sendMsgToFCL msg param

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/CompositeSignature.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/on-message-from-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/wallet-utils/send-msg-to-fcl.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Removed useless casts

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Fixed connection not working

* Refactored fcl-core interaction-template-utils folder files to TypeScript (#2474)

* Completed refactoring of interaction-template-utils folder

* Update packages/fcl-core/src/interaction-template-uti
6DAF
ls/generate-template-id/generate-template-id-1.1.0.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Improved dependency pin test

* Fixed console warn spy on tests

* Added suggestion

* Update packages/fcl-core/src/interaction-template-utils/generate-template-id/generate-template-id-1.0.0.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Update packages/fcl-core/src/interaction-template-utils/generate-template-id/generate-template-id.ts

Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>

* Refactored fcl-core normalizers folder files to TypeScript (#2475)

* Refactored normalizers folder

* Fixed post merging issues

* Updated comments

* Updated service normalizers

* Update packages/fcl-core/src/normalizers/service/open-id.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Big documentation update (#2532)

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Added changeset

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Co-authored-by: Jordan Ribbink <17958158+jribbink@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Refactored fcl package to TypeScript (#2492)

* Added direct core types export

* Minor version file refactor to ts

* Updated readme

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Added changeset

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
* Added core types and minor refactor (#2493)

Co-authored-by: mfbz <mfbz@users.noreply.github.com>

* Added changeset

---------

Co-authored-by: mfbz <mfbz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create script to automate packages reference docs generation
2 participants
0