Add/Update `dapp-orca-basics` Docs #1232

amessbee · 2024-10-07T08:28:47Z

The changes include:

There are some structural changes - there is no getting-started directory in orchestration - that's one less instance getting-started in our docs now.
contract-walkthroughs.md is now contract-walkthrough/index.md.
There is a orca dApp contract walkthrough.
There is a prelim. version of corresponding UI walkthrough.

I also capitalized Orchestration everywhere for the sake of uniformity.

cloudflare-workers-and-pages · 2024-10-07T10:37:47Z

Deploying documentation with Cloudflare Pages

Latest commit:	`21bdf09`
Status:	✅ Deploy successful!
Preview URL:	https://efbf0fc9.documentation-7tp.pages.dev
Branch Preview URL:	https://ms-adding-orca-dapp-docs.documentation-7tp.pages.dev

View logs

mujahidkay

Left some comments :)

mujahidkay · 2024-10-08T11:12:57Z

main/.vitepress/config.mjs

            },
            {
              text: 'Contract Walkthroughs',
-              link: '/guides/orchestration/getting-started/contract-walkthroughs',
+              link: '/guides/orchestration/contract-walkthrough',


Suggested change

link: '/guides/orchestration/contract-walkthrough',

link: '/guides/orchestration/contract-walkthroughs',

for all sub-items too

mujahidkay · 2024-10-08T11:15:47Z

main/.vitepress/config.mjs

+              ]
+            },
+            {
+              text: 'Example Orchestration DApp',


Ideally, like we discussed in today's sync, I would like this to be after key concepts but it doesn't have to be done in this PR. We would also need to rethink what to call that section because then Example Orchestration Dapp wouldn't work imo

mujahidkay · 2024-10-08T11:16:23Z

main/.vitepress/themeConfig/nav.js

      },
      {
        text: 'Contract Walkthroughs',
        items: [
          {
            text: 'Send Anywhere Example',
-            link: '/guides/orchestration/getting-started/contract-walkthrough/send-anywhere',
+            link: '/guides/orchestration/contract-walkthrough/send-anywhere',


/contract-walkthroughs/ all instances here too

mujahidkay · 2024-10-08T11:20:33Z

main/guides/orchestration/contract-walkthrough/index.md

Changing the directory structure results in a different URL for the page. For retaining SEO juice, we need to add redirects from previous pages to new ones. You will have to add these entries to _redirects file

mujahidkay · 2024-10-08T11:38:29Z

main/guides/orchestration/index.md

@@ -13,7 +13,7 @@ The Orchestration API handles asynchronous tasks and complex workflows, includin

 # Introduction to Orchestration API Flow

-The following sequence diagram provides a comprehensive overview of the orchestration process within the Agoric platform. This example illustrates the interaction between various components, highlighting how the orchestration library (`OrchLib`) facilitates cross-chain operations. This is a good first example to understand the flow of the Orchestration API, showing the steps involved in creating and managing cross-chain transactions.
+The following sequence diagram provides a comprehensive overview of the Orchestration process within the Agoric platform. This example illustrates the interaction between various components, highlighting how the Orchestration library (`OrchLib`) facilitates cross-chain operations. This is a good first example to understand the flow of the Orchestration API, showing the steps involved in creating and managing cross-chain transactions.


we should create an issue to update all such outdated terms like OrchLib

mujahidkay · 2024-10-08T11:40:19Z

main/guides/orchestration/orchestration-basics/contract.md

+1. [`orca.contract.js`](https://github.com/Agoric/dapp-orchestration-basics/blob/main/contract/src/orca.contract.js)
+2. [`orca.flows.js`](https://github.com/Agoric/dapp-orchestration-basics/blob/main/contract/src/orca.flows.js)
+
+## Walkthrough: `orca.contract.js`


Suggested change

## Walkthrough: `orca.contract.js`

## `orca.contract.js`

redundant imo

mujahidkay · 2024-10-08T11:40:37Z

main/guides/orchestration/orchestration-basics/contract.md

+harden(start);
+```
+
+## Walkthrough `orca.flows.js`


Suggested change

## Walkthrough `orca.flows.js`

## `orca.flows.js`

mujahidkay · 2024-10-08T11:50:23Z

main/guides/orchestration/orchestration-basics/contract.md

+
+- **Creating Account and Funding Functions**: These functions are created using the `orchestrateAll` helper, which sets
+  up the necessary flow logic for account creation and funding but the logic is implemented in `orca.flows.js` file
+  ([discussed below](#walkthrough-orcaflowsjs)).


Suggested change

([discussed below](#walkthrough-orcaflowsjs)).

([discussed below](#walkthrough-orcaflowsjs)).

seems like a dead anchor but it has to be updated regardless if we update the h2s. THen it should become '#orca-flows-js' I believe

mujahidkay · 2024-10-08T11:54:03Z

main/guides/orchestration/orchestration-basics/ui.md

+
+Here, we will walkthrough the components making up the user interface for the Orchestration dApp.
+
+## Orchestration.tsx


I would suggest using component name rather than filename for each of these (the component is called Orchestration)

mujahidkay · 2024-10-08T11:54:43Z

main/guides/orchestration/orchestration-basics/ui.md

+
+## Orchestration.tsx
+
+The `Orchestration.tsx` component serves as the main controller for the Orchestration dApp's user interface. It manages


Same here. We can hyperlink the component to this src file here in the body.

mujahidkay · 2024-10-08T18:34:34Z

_redirects

@@ -44,6 +44,11 @@
 /guides/js-programming/ses/ses-guide.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md 
 /guides/js-programming/ses/ses-reference https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md 
 /guides/js-programming/ses/ses-reference.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/reference.md 
+/guides/orchestration/getting-started/key-concepts /guides/orchestration/key-concepts


we also need to add corresponding html entries

I wonder if this can be automated - at least for changes in navbar/sidebar config files.

Fixed. Have a careful look though, I have never added to _redirects before.

mujahidkay · 2024-10-08T18:35:52Z

main/guides/orchestration/orchestration-basics/contract.md

+
+- **Creating Account and Funding Functions**: These functions are created using the `orchestrateAll` helper, which sets
+  up the necessary flow logic for account creation and funding but the logic is implemented in `orca.flows.js` file
+  ([discussed below](#orcaflowsjs)).


Suggested change

([discussed below](#orcaflowsjs)).

([discussed below](#orca-flows-js)).

For some reason, this was suggested by vscode.

mujahidkay

Good work!

Somehow the "Contract Walkthroughs" page isn't highlighted in the sidebar so if you can debug and fix that, it would be great.

amessbee · 2024-10-09T13:08:11Z

Good work!

Somehow the "Contract Walkthroughs" page isn't highlighted in the sidebar so if you can debug and fix that, it would be great.

Thanks. Fixed.

docs: orca contract walkthrough

amessbee self-assigned this Oct 7, 2024

amessbee force-pushed the ms/adding-orca-dapp-docs branch 2 times, most recently from 6b2a88c to c1bf13a Compare October 7, 2024 12:48

amessbee changed the title ~~Add/Update dapp-orca-basics Docs --WIP--~~ Add/Update dapp-orca-basics Docs Oct 7, 2024

amessbee marked this pull request as ready for review October 7, 2024 14:03

amessbee requested review from mujahidkay and Jovonni October 7, 2024 14:03

mujahidkay reviewed Oct 8, 2024

View reviewed changes

amessbee requested a review from mujahidkay October 8, 2024 15:05

amessbee force-pushed the ms/adding-orca-dapp-docs branch 2 times, most recently from a06291f to bdfce2b Compare October 8, 2024 17:46

mujahidkay reviewed Oct 8, 2024

View reviewed changes

amessbee force-pushed the ms/adding-orca-dapp-docs branch from bdfce2b to f6e494c Compare October 9, 2024 05:03

mujahidkay approved these changes Oct 9, 2024

View reviewed changes

amessbee force-pushed the ms/adding-orca-dapp-docs branch from 4a28808 to 57d847f Compare October 9, 2024 12:15

amessbee force-pushed the ms/adding-orca-dapp-docs branch from 7ebbc5d to b54fdc8 Compare October 9, 2024 13:12

amessbee added 3 commits October 9, 2024 18:14

chore: update orca docs structure/nav/sidebar

8110710

docs: orca contract walkthrough

docs; orca dapp UI docs

fa8b5e0

chore: adding modified links _redirects

21bdf09

amessbee force-pushed the ms/adding-orca-dapp-docs branch from b54fdc8 to 21bdf09 Compare October 9, 2024 13:17

amessbee merged commit 54b346b into main Oct 9, 2024
6 checks passed

amessbee deleted the ms/adding-orca-dapp-docs branch October 9, 2024 13:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add/Update `dapp-orca-basics` Docs #1232

Add/Update `dapp-orca-basics` Docs #1232

amessbee commented Oct 7, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 7, 2024 •

edited

Loading

mujahidkay left a comment

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

mujahidkay Oct 8, 2024

amessbee Oct 9, 2024

amessbee Oct 9, 2024 •

edited

Loading

amessbee Oct 9, 2024

mujahidkay Oct 8, 2024

amessbee Oct 9, 2024

mujahidkay left a comment

amessbee commented Oct 9, 2024

	link: '/guides/orchestration/contract-walkthrough',
	link: '/guides/orchestration/contract-walkthroughs',

	([discussed below](#walkthrough-orcaflowsjs)).
	([discussed below](#walkthrough-orcaflowsjs)).


		Here, we will walkthrough the components making up the user interface for the Orchestration dApp.

		## Orchestration.tsx


		## Orchestration.tsx

		The `Orchestration.tsx` component serves as the main controller for the Orchestration dApp's user interface. It manages

	([discussed below](#orcaflowsjs)).
	([discussed below](#orca-flows-js)).

Add/Update dapp-orca-basics Docs #1232

Add/Update dapp-orca-basics Docs #1232

Conversation

amessbee commented Oct 7, 2024 • edited Loading

cloudflare-workers-and-pages bot commented Oct 7, 2024 • edited Loading

Deploying documentation with Cloudflare Pages

mujahidkay left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amessbee Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mujahidkay left a comment

Choose a reason for hiding this comment

amessbee commented Oct 9, 2024

Add/Update `dapp-orca-basics` Docs #1232

Add/Update `dapp-orca-basics` Docs #1232

amessbee commented Oct 7, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Oct 7, 2024 •

edited

Loading

amessbee Oct 9, 2024 •

edited

Loading