chore: update SDP docs build #440
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview is available here: |
marcelosalloum
approved these changes
Apr 9, 2024
marcelosalloum
pushed a commit
that referenced
this pull request
Apr 11, 2024
When running the `yarn api` these files are rebuilt due to a new authenticate method added (`Basic Auth`). This PR only updates these files to the latest version. The changes are related to this #397.
marcelosalloum
pushed a commit
that referenced
this pull request
Apr 11, 2024
When running the `yarn api` these files are rebuilt due to a new authenticate method added (`Basic Auth`). This PR only updates these files to the latest version. The changes are related to this #397.
marwen-abid
added a commit
that referenced
this pull request
Jun 6, 2024
* [SDP-1139] sdp: add SDP multi-tenant migration doc (#394) * feat: add SDP multi-tenant migration doc * chore: address PR comments * [SDP-1056] sdp: add SDP Admin API spec (#397) * feat: add SDP Admin API spec * chore: address PR comments * fix: remove distribution_account field * SDP-1054 update design and architecture docs * Update the "Getting Started" section. * chore: update SDP docs build (#440) When running the `yarn api` these files are rebuilt due to a new authenticate method added (`Basic Auth`). This PR only updates these files to the latest version. The changes are related to this #397. * [SDP-1100] Default tenant endpoint (#455) This PR adds the default tenant endpoint that sets a tenant as the default in the system. --------- Authored-by: Caio Teixeira <[email protected]> * [SDP-1151] Update single-tenant to multi-tenant migration guide (#496) ### What Update the single-tenant to multi-tenant migration guide with the following changes: * Update the status requirements saying that the only payments/submitter_transactions statuses that need to be solved before the migration are PENDING/PROCESSING * Reorganize the content * Add extra sections with more info * Include new commands and SQL queries to make the migration easier. * Add TODOs: - [x] stellar/stellar-disbursement-platform-backend#262 - [ ] stellar/stellar-disbursement-platform-backend#266 - [ ] https://stellarorg.atlassian.net/browse/SDP-1148 * [SDP-1151] Polish the single-tenant to multi-tenant migration guide (#511) * [SDP-1157] add `Configuring the SDP` page (#512) * SDP-1157 adding `Configuring the SDP` page * SDP-1157 adding `Configuring the SDP` page * SDP-1157 address PR comments * SDP-1157 move sdp API under api-reference folder * Fix broken link * Change architecture diagram * Update instructions with the updated field name. * add tenant resolution and multi-tenant subdomain info. (#578) * add tenant resolution and multi-tenant subdomain info. * address PR comments * Enforce the necessity to include the home domain in the SDP SEP-10 challenge GET request (#654) ### Why To keep the docs up to date with the code. This is now required in the multitenant instance. * [SDP] Polish the docs for the multitenant 2.0.0 release (#656) ### Changes - Add the missing DELETE /tenants/:id API documentation - Update the request and response bodies in the /tenants API. - Updated the checksum on the .api.mdx files by running `yarn api` --------- Co-authored-by: Caio Teixeira <[email protected]> Co-authored-by: Erica <[email protected]> Co-authored-by: Marcelo Salloum dos Santos <[email protected]> Co-authored-by: Marcelo Salloum <[email protected]>
janewang
pushed a commit
that referenced
this pull request
Jun 18, 2024
* Changing "Soroban CLI" to "Stellar CLI" * Update soroban-cli version. (#634) * Update some CLI commands * Remove Deadlink - Stellar Authenticator (#637) * Update setup.mdx (#644) The soroban-cli version in this doc is outdated and will give the following error when invoking a deployed contract: "error: xdr processing error: xdr value invalid" As specified here an update of the CLI version is needed: https://stellar.org/blog/developers/protocol-21-upgrade-guide * Update smart-contract-deployment.mdx (#645) The it is an issue in the vault contract's withdraw function which will incorrectly update the value of Reserve. In this line let balance = get_token_balance(&e); balance is updated AFTER the transfer of the user deposit + yield has already occurred. Thus the balance fetched is already the current "reserve" balance of the Vault. So when the following line of code executes: put_reserve(&e, balance - amount); the Reserve is updated to the balance of the Vault contract - the amount withdrawn by the user, so it will count the withdrawn 2 times. Indeed when following the test the result from "get_rsrvs" in the first scenario will be : "-1" Initial balance of the Vault: 200 - amount: 100 + yield: 1 (from the transfer) - amount: 100 (from the put_reserve input). For further improvements the get_rsrvs should only account for the amount of reward tokens that the vault is holding which can be useful to obtain the deposited amount (vault balance - reserves). Additionally the --wasm argument in the "invoke" command is not needed and it was removed. * [SDP-1054] Updating Stellar Docs for SDP multi-tenant (#407) * [SDP-1139] sdp: add SDP multi-tenant migration doc (#394) * feat: add SDP multi-tenant migration doc * chore: address PR comments * [SDP-1056] sdp: add SDP Admin API spec (#397) * feat: add SDP Admin API spec * chore: address PR comments * fix: remove distribution_account field * SDP-1054 update design and architecture docs * Update the "Getting Started" section. * chore: update SDP docs build (#440) When running the `yarn api` these files are rebuilt due to a new authenticate method added (`Basic Auth`). This PR only updates these files to the latest version. The changes are related to this #397. * [SDP-1100] Default tenant endpoint (#455) This PR adds the default tenant endpoint that sets a tenant as the default in the system. --------- Authored-by: Caio Teixeira <[email protected]> * [SDP-1151] Update single-tenant to multi-tenant migration guide (#496) ### What Update the single-tenant to multi-tenant migration guide with the following changes: * Update the status requirements saying that the only payments/submitter_transactions statuses that need to be solved before the migration are PENDING/PROCESSING * Reorganize the content * Add extra sections with more info * Include new commands and SQL queries to make the migration easier. * Add TODOs: - [x] stellar/stellar-disbursement-platform-backend#262 - [ ] stellar/stellar-disbursement-platform-backend#266 - [ ] https://stellarorg.atlassian.net/browse/SDP-1148 * [SDP-1151] Polish the single-tenant to multi-tenant migration guide (#511) * [SDP-1157] add `Configuring the SDP` page (#512) * SDP-1157 adding `Configuring the SDP` page * SDP-1157 adding `Configuring the SDP` page * SDP-1157 address PR comments * SDP-1157 move sdp API under api-reference folder * Fix broken link * Change architecture diagram * Update instructions with the updated field name. * add tenant resolution and multi-tenant subdomain info. (#578) * add tenant resolution and multi-tenant subdomain info. * address PR comments * Enforce the necessity to include the home domain in the SDP SEP-10 challenge GET request (#654) ### Why To keep the docs up to date with the code. This is now required in the multitenant instance. * [SDP] Polish the docs for the multitenant 2.0.0 release (#656) ### Changes - Add the missing DELETE /tenants/:id API documentation - Update the request and response bodies in the /tenants API. - Updated the checksum on the .api.mdx files by running `yarn api` --------- Co-authored-by: Caio Teixeira <[email protected]> Co-authored-by: Erica <[email protected]> Co-authored-by: Marcelo Salloum dos Santos <[email protected]> Co-authored-by: Marcelo Salloum <[email protected]> * Rewriting scaling documentation (#659) * rpc: add getFeeStats method documentation (#660) * rpc: add getFeeStats method * Address review feedback * Remove unneeded stop * Add some description updates --------- Co-authored-by: Jane Wang <[email protected]> * Soroban RPC: Add document for getVersionInfo RPC (#661) * Add document for getVersionInfo RPC * update info * Add captive core info * Add a table of hardware requirements for various node types (#568) * add a doc with a requirements comparison table * add some sidebar content for new-ish section * adjust some heading config for platforms pages * Fix command for adding new networks. (#667) * Adding Tokens Overview (wayfinding) (#570) * Adding Tokens Overview (wayfinding) * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * formatting * more updates * update copy * couple nits * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Jake Urban <[email protected]> * update wording * update note * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * G & C addresses * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * Update docs/smart-contracts/tokens/wayfinding.mdx Co-authored-by: Leigh McCulloch <[email protected]> * wording * formatting --------- Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Jake Urban <[email protected]> * Categorize Learn Section (#646) * Categorize Learn Section * moving things around * fix links * more links * mas links * beaucoup links * mais links * authorization heading fix * message * little nits * Fix link (#675) * Learn section redirects (#678) * Add examples of invoking contracts using Python SDK and Java SDK. (#643) * Add examples of calling contracts using Python SDK and Java SDK * rename file * fix js example * Add hubble diagrams and data dicts (#670) Add hubble diagrams and data dicts * Add Passkey Library session to meeting notes (#681) * update meeting notes * Update 2024-06-13.mdx * Update 2024-06-13.mdx * Update 2024-06-13.mdx --------- Co-authored-by: Tyler van der Hoeven <[email protected]> * Add Ortege to Block Explorers (#671) * Add Ortege to Block Explorers * Update developer-tools.mdx * Update Software Versions for Protocol 21: Mainnet (#685) * Update Software Versions for Protocol 21: Mainnet * adding versions back to be updated * rpc: Add `getTransactions` documentation (#636) * Add getTransactions documenation - 1 * Add getTransactions documentation - 2 * Add getTransactions documentation - 4 * Refactor Pagination changes * Refactor the params object in getTransactions examples * Change naming to only RPC * Change description of diagnosticEventsXdr * Add "items" * Update openrpc/src/methods/getTransactions.json Co-authored-by: George <[email protected]> * Update openrpc/src/schemas/Cursor.json Co-authored-by: George <[email protected]> * Update openrpc/src/schemas/Pagination.json Co-authored-by: George <[email protected]> * Small changes - 1 * Remove links - 1 * Remove links - 2 * Fix broken TOID link --------- Co-authored-by: George <[email protected]> * Updates to Getting Started Docs (#674) * Update soroban output to current 21.x state * Fix naming for HelloContractClient * Consistent directory names * formatting and link --------- Co-authored-by: Bri <[email protected]> * Add more detail to overlay survey instructions (#653) * Add more detail to overlay survey instructions This change adds some additional instructions to the overlay survey section of the admin guide. Specifically, it adds: * Instructions on how to use the overlay survey script. * Information about the `nonce` field in the "start/stop collecting" messages. * Explicit instructions on how to opt-out of the survey. * Recommendations for collecting phase durations. * Small tweaks to fix grammar/formatting/example errors found while editing the section * Add links * Add admin-guide for hubble (#669) Add admin-guide for hubble * typo fix in cli guid (#693) * Update docs/smart-contracts/getting-started/setup.mdx Co-authored-by: Nando Vieira <[email protected]> * Changing "Soroban CLI" to "Stellar CLI" * Update some CLI commands * Add more cli updates * Update to stellar cli * Fix path --------- Co-authored-by: Nando Vieira <[email protected]> Co-authored-by: Jane Wang <[email protected]> Co-authored-by: Ricky Lindenhovius <[email protected]> Co-authored-by: FrankFourier <[email protected]> Co-authored-by: Marwen Abid <[email protected]> Co-authored-by: Caio Teixeira <[email protected]> Co-authored-by: Erica <[email protected]> Co-authored-by: Marcelo Salloum dos Santos <[email protected]> Co-authored-by: Marcelo Salloum <[email protected]> Co-authored-by: Molly Karcher <[email protected]> Co-authored-by: Alfonso Acosta <[email protected]> Co-authored-by: Prit Sheth <[email protected]> Co-authored-by: Elliot Voris <[email protected]> Co-authored-by: Leigh McCulloch <[email protected]> Co-authored-by: Jake Urban <[email protected]> Co-authored-by: Jun Luo <[email protected]> Co-authored-by: chowbao <[email protected]> Co-authored-by: Julian Martinez <[email protected]> Co-authored-by: Tyler van der Hoeven <[email protected]> Co-authored-by: Aditya Vyas <[email protected]> Co-authored-by: George <[email protected]> Co-authored-by: Pam S <[email protected]> Co-authored-by: Brett Boston <[email protected]> Co-authored-by: Rahul Soshte <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When running the
yarn apithese files are rebuilt due to a new authenticate method added (Basic Auth). This PR only updates these files to the latest version.The changes are related to this #397.