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

Fix documentation rendering #965

Merged
merged 67 commits into from
Sep 24, 2024
Merged

Fix documentation rendering #965

merged 67 commits into from
Sep 24, 2024

Commits on May 10, 2024

  1. update README badges

    @ElliotFriend
    ElliotFriend committed May 10, 2024
    Configuration menu
    Copy the full SHA
    9ee3090 View commit details
    Browse the repository at this point in the history

  2. remove conflicting class tags from call builder classes

    @ElliotFriend
    ElliotFriend committed May 10, 2024
    Configuration menu
    Copy the full SHA
    8317c6c View commit details
    Browse the repository at this point in the history

Commits on May 11, 2024

  1. Merge branch 'master' into 920-documentation-rendering

    @ElliotFriend
    ElliotFriend committed May 11, 2024
    Configuration menu
    Copy the full SHA
    96b0796 View commit details
    Browse the repository at this point in the history

Commits on May 13, 2024

  1. removing old soroban links in README.md

    @ElliotFriend
    ElliotFriend committed May 13, 2024
    Configuration menu
    Copy the full SHA
    a5e188d View commit details
    Browse the repository at this point in the history

  2. changing old soroban link in another readme file

    @ElliotFriend
    ElliotFriend committed May 13, 2024
    Configuration menu
    Copy the full SHA
    82335be View commit details
    Browse the repository at this point in the history

  3. changing old soroban links to new home in dev docs

    @ElliotFriend
    ElliotFriend committed May 13, 2024
    Configuration menu
    Copy the full SHA
    cdfe297 View commit details
    Browse the repository at this point in the history

  4. make WebAuth show up as a namespace

    @ElliotFriend
    ElliotFriend committed May 13, 2024
    Configuration menu
    Copy the full SHA
    e7d721c View commit details
    Browse the repository at this point in the history

Commits on May 14, 2024

  1. collect methods and classes into a SorobanRpc namespace for JSDoc

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    8bc0f5a View commit details
    Browse the repository at this point in the history

  2. create a Horizon JSDoc namespace and add the server class to it

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    887f35c View commit details
    Browse the repository at this point in the history

  3. fix broken links to API dev docs

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    0b5b3e8 View commit details
    Browse the repository at this point in the history

  4. add the Durability enum to the SorobanRPC JSDoc namespace

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    1c7c9b0 View commit details
    Browse the repository at this point in the history

  5. fix links to the SorobanRPC server methods

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    f1eb36a View commit details
    Browse the repository at this point in the history

  6. link call builders to the horizon.server methods

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    22db24a View commit details
    Browse the repository at this point in the history

  7. create a util namespace and add validateTimebounds to it

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    9d663a1 View commit details
    Browse the repository at this point in the history

  8. remove unnecessary code blocks from ContractSpec examples

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    c1d6a11 View commit details
    Browse the repository at this point in the history

  9. group some const declarations into more relevant namespaces/classes

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    aee50b1 View commit details
    Browse the repository at this point in the history

  10. make a stellartoml JSDoc namespace

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    94bd492 View commit details
    Browse the repository at this point in the history

  11. flesh out the jsdoc info for the jsonrpc postObject function

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    ce3d74c View commit details
    Browse the repository at this point in the history

  12. some minor jsdoc fixups

    @ElliotFriend
    ElliotFriend committed May 14, 2024
    Configuration menu
    Copy the full SHA
    d908609 View commit details
    Browse the repository at this point in the history

Commits on May 16, 2024

  1. make federation a module, include the typedefs

    @ElliotFriend
    ElliotFriend committed May 16, 2024
    Configuration menu
    Copy the full SHA
    9f4555b View commit details
    Browse the repository at this point in the history

  2. add throws tags to federation methods

    @ElliotFriend
    ElliotFriend committed May 16, 2024
    Configuration menu
    Copy the full SHA
    260b9c2 View commit details
    Browse the repository at this point in the history

Commits on May 17, 2024

  1. mark most of the "call builder" classes as private in JSDoc 

    Since the comments clearly say "don't make this class yourself,"
it might make sense to mark them as `@private` so they don't show
up in the documentation.

The doc pages for those classes can still be visited, but they
don't show up in the sidebar to the left, unless you specifically
navigate to one of them. (Or, if you click a link for what the
return type on the `Horizon.Server.effects()` method, for example
    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    879b9b5 View commit details
    Browse the repository at this point in the history

  2. fine-tune the JSDoc syntaxes and types in config.ts

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    3da0c0b View commit details
    Browse the repository at this point in the history

  3. JSDoc fixes for the Utils class

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    a19df6e View commit details
    Browse the repository at this point in the history

  4. mark the Ok and Err rust type classes as private in JSDoc 

    I don't _think_ they're accessible by SDK users, so I think it
makes sense to not render them in the docs?
    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    8253b25 View commit details
    Browse the repository at this point in the history

  5. change StellarToml from a JSDoc namespace to a module

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    db23f84 View commit details
    Browse the repository at this point in the history

  6. change webauth from a JSDoc namespace to a module

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    bdf6dbb View commit details
    Browse the repository at this point in the history

  7. make SorobanRpc a JSDoc module instead of a namespace

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    8269c16 View commit details
    Browse the repository at this point in the history

  8. mark the AccountResponse class as private in JSDoc

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    d04527a View commit details
    Browse the repository at this point in the history

  9. add soroban tx timeout const to the SorobanRpc.Server module

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    ae18fa4 View commit details
    Browse the repository at this point in the history

  10. try out a new JSDoc theme

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    51f8016 View commit details
    Browse the repository at this point in the history

  11. Merge branch 'master' into 920-documentation-rendering

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    3ae5a6f View commit details
    Browse the repository at this point in the history

  12. rename SorobanRpc to rpc in JSDoc comments

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    334731a View commit details
    Browse the repository at this point in the history

  13. make contract a JSDoc module

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    d95209f View commit details
    Browse the repository at this point in the history

  14. mark contract export as private in JSDoc 

    There was a weird `_default` global that came up from this. Not
sure why, but this seems to have done the trick without anything
weird going on after.
    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    937b7b1 View commit details
    Browse the repository at this point in the history

  15. mark postObject as private in JSDoc 

    it doesn't look like it's accessible anywhere for an SDK user, so
let's hide it from the generated docs
    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    a0e21ff View commit details
    Browse the repository at this point in the history

  16. mark contract/utils functions as private in JSDoc

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    b684b80 View commit details
    Browse the repository at this point in the history

  17. remove unused import to fix tests (i think?)

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    0195708 View commit details
    Browse the repository at this point in the history

  18. add some default values to JSDoc constants

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    422c3a2 View commit details
    Browse the repository at this point in the history

  19. fix error message type

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    b0b93bb View commit details
    Browse the repository at this point in the history

  20. break the errors classes into multiple files for JSDoc rendering

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    403d165 View commit details
    Browse the repository at this point in the history

  21. add JSDoc type definition to friendbot api 

    because more type definitions are more better, right?
    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    4efede5 View commit details
    Browse the repository at this point in the history

  22. add default value to max toml file size in JSDoc

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    afd392b View commit details
    Browse the repository at this point in the history

  23. try to clarify when timebounds are attached to tx in JSDoc

    @ElliotFriend
    ElliotFriend committed May 17, 2024
    Configuration menu
    Copy the full SHA
    462e5f6 View commit details
    Browse the repository at this point in the history

Commits on May 21, 2024

  1. clarify note about when the timebounds are added to client txs

    @ElliotFriend
    ElliotFriend committed May 21, 2024
    Configuration menu
    Copy the full SHA
    5b12f6b View commit details
    Browse the repository at this point in the history

Commits on Jun 4, 2024

  1. Merge remote-tracking branch 'origin/master' into 920-documentation-r… 

    …endering
    @ElliotFriend
    ElliotFriend committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    6f74f95 View commit details
    Browse the repository at this point in the history

  2. update some federation links

    @ElliotFriend
    ElliotFriend committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    a42c08e View commit details
    Browse the repository at this point in the history

  3. fixes to rpc server links, types, etc.

    @ElliotFriend
    ElliotFriend committed Jun 4, 2024
    Configuration menu
    Copy the full SHA
    e2707c4 View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. some fixes to links, params, etc. in WebAuth module

    @ElliotFriend
    ElliotFriend committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    0ac4f7d View commit details
    Browse the repository at this point in the history

Commits on Jun 18, 2024

  1. improving docs rendering for errors

    @ElliotFriend
    ElliotFriend committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    afaf06e View commit details
    Browse the repository at this point in the history

  2. Merge remote-tracking branch 'origin/master' into 920-documentation-r… 

    …endering
    @ElliotFriend
    ElliotFriend committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    643a330 View commit details
    Browse the repository at this point in the history

  3. remove unused jsdoc theme package

    @ElliotFriend
    ElliotFriend committed Jun 18, 2024
    Configuration menu
    Copy the full SHA
    4c164c4 View commit details
    Browse the repository at this point in the history

Commits on Sep 17, 2024

  1. move better-docs to dev deps, remove old jsdoc theme minami

    @ElliotFriend
    ElliotFriend committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    ceaf127 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'master' of github.com:stellar/js-stellar-sdk into 920-d… 

    …ocumentation-rendering
    @ElliotFriend
    ElliotFriend committed Sep 17, 2024
    Configuration menu
    Copy the full SHA
    59ba38e View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2024

  1. formatting and linting

    @ElliotFriend
    ElliotFriend committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    38ef48a View commit details
    Browse the repository at this point in the history

  2. ignore test output file from prettier

    @ElliotFriend
    ElliotFriend committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    f5665b0 View commit details
    Browse the repository at this point in the history

  3. use correct github link in docs site header

    @ElliotFriend
    ElliotFriend committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    dd3cee8 View commit details
    Browse the repository at this point in the history

  4. correct old rpc and horizon docs urls

    @ElliotFriend
    ElliotFriend committed Sep 18, 2024
    Configuration menu
    Copy the full SHA
    c5a125c View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2024

  1. tweak docs for config class and interface 

    this commit also exports the `Configuration` interface
    @ElliotFriend
    ElliotFriend committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    d4db2c5 View commit details
    Browse the repository at this point in the history

  2. fix all Server.* modules being lumped together

    @ElliotFriend
    ElliotFriend committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    fa9f6c8 View commit details
    Browse the repository at this point in the history

  3. add exceptions for unknown jsdoc tags from base repo

    @ElliotFriend
    ElliotFriend committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    a18da01 View commit details
    Browse the repository at this point in the history

Commits on Sep 20, 2024

  1. some fine-tuning and tweaks

    @ElliotFriend
    ElliotFriend committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    f5652ed View commit details
    Browse the repository at this point in the history

  2. fold rust result interfaces into the contract module

    @ElliotFriend
    ElliotFriend committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    0980205 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'master' of github.com:stellar/js-stellar-sdk into 920-d… 

    …ocumentation-rendering
    @ElliotFriend
    ElliotFriend committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    139a1da View commit details
    Browse the repository at this point in the history

  4. use prettier in src directory

    @ElliotFriend
    ElliotFriend committed Sep 20, 2024
    Configuration menu
    Copy the full SHA
    841f7c9 View commit details
    Browse the repository at this point in the history

Commits on Sep 24, 2024

  1. Revert "use prettier in src directory" 

    This reverts commit 841f7c9.
    @ElliotFriend
    ElliotFriend committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    972f3bd View commit details
    Browse the repository at this point in the history

  2. Merge branch 'master' of github.com:stellar/js-stellar-sdk into 920-d… 

    …ocumentation-rendering
    @ElliotFriend
    ElliotFriend committed Sep 24, 2024
    Configuration menu
    Copy the full SHA
    719c90f View commit details
    Browse the repository at this point in the history