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

fix: broken internal links at multiple pages issue #1071 #1115

Merged
10 commits merged into from
Jun 25, 2024
Merged

fix: broken internal links at multiple pages issue #1071 #1115

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2d2c8e2
fix: borken links to cosmos-delegators-cli
amessbee Jun 3, 2024
96f5bf2
fix: removed parts in chain-integration with outdated links.
amessbee Jun 3, 2024
0c72634
fix: broken link in proposal.md
amessbee Jun 3, 2024
d2684a8
fix: typo link in zoe.md
amessbee Jun 3, 2024
5beb84a
fix: link to ui-component changed to ui-kit repo
amessbee Jun 3, 2024
89e3c5a
fix: workshop link to cosmos is broken.
amessbee Jun 3, 2024
8579805
fix: broken delegators link
amessbee Jun 3, 2024
bdfaecf
fix: link cosmos code with us to yt video
amessbee Jun 6, 2024
3641f96
fix: adding reference to offerArgs in zoe.md
amessbee Jun 20, 2024
a2109f4
docs: reverting proposed changes from chain-integration.md
amessbee Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion main/guides/agoric-cli/agd-query-tx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This section focusses on commands relevant to developing and deploying smart con

- [Validators topics \- Agoric Community Forum](https://community.agoric.com/c/validators/9)
- [Governance topics \- Agoric Community Forum](https://community.agoric.com/c/governance/6)
- [Delegator Guide \(CLI\) \| Cosmos Hub](https://hub.cosmos.network/main/delegators/delegator-guide-cli.html)
- [Delegator Guide \(CLI\) \| Cosmos Hub](https://hub.cosmos.network/delegators/delegator-guide-cli.html)

:::

Expand Down
2 changes: 1 addition & 1 deletion main/guides/coreeval/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Until mainnet enters the Mainnet-3 phase of the [multi-phase mainnet rollout](ht
permissionless [contract installation with Zoe](/guides/zoe/#contract-installation)
is limited to development environments.

Until then, permission to deploy contracts can be granted using an Agoric extension to [Cosmos SDK Governance](https://hub.cosmos.network/main/delegators/delegator-guide-cli.html#participating-in-governance) called `swingset.CoreEval`. As discussed in [governance using Hardened JavaScript: swingset\.CoreEval](https://community.agoric.com/t/bld-staker-governance-using-hardened-javascript-swingset-coreeval/99),
Until then, permission to deploy contracts can be granted using an Agoric extension to [Cosmos SDK Governance](https://hub.cosmos.network/delegators/delegator-guide-cli.html#participating-in-governance) called `swingset.CoreEval`. As discussed in [governance using Hardened JavaScript: swingset\.CoreEval](https://community.agoric.com/t/bld-staker-governance-using-hardened-javascript-swingset-coreeval/99),
if such a proposal passes, its JavaScript code is run with ocaps extracted using the proposal's permitted capabilities, which the code can combine to perform privileged tasks.

To make a proposal to deploy a contract:
Expand Down
2 changes: 1 addition & 1 deletion main/guides/coreeval/proposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ There are also several more promise spaces one level down, including:
- `powers.issuer`
- `powers.brand`

The `installContract` helper calls `E(zoe).installBundleID(bundleID)` to create an `Installation`, much like our earlier discussion of [Contract installation](http://localhost:8080/guides/zoe/#contract-installation).
The `installContract` helper calls `E(zoe).installBundleID(bundleID)` to create an `Installation`, much like our earlier discussion of [Contract installation](../zoe/#contract-installation).
It also calls `powers.installation[name].resolve(installation)`.

```js
Expand Down
15 changes: 1 addition & 14 deletions main/guides/integration/chain-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,8 @@ This section points at relevant reference documentation for the underlying `cosm

The Agoric Network currently uses `cosmos-sdk` v0.45. The general Cosmos documentation for this version can be [found here](https://docs.cosmos.network/v0.45/), including structure and`golang` documentation, and REST API documentation.

Use the [v0.45.1 version of the REST API](https://v1.cosmos.network/rpc/v0.45.1) for accessing the chain. To use the "Try it out" functionality, change the Base URL to `agoric-api.polkachu.com`:


| ![Alt name of image](./assets/cosmos-api.png) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that image was pretty handy - are you proposing to omit it?

Copy link
Author

@ghost ghost Jun 3, 2024 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I honestly don't know whether to keep or remove it - this page does not exist anymore though.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ugh. I suppose that's worth its own issue:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dckc reckon we can merge changes to the rest of the files?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.cosmos.network/api ?

|-|

The chain can also be accessed via JavaScript using the [`cosmjs` library](https://github.com/cosmos/cosmjs) (and [associated tutorials](https://tutorials.cosmos.network/tutorials/7-cosmjs/1-cosmjs-intro.html)), or using [CosmosKit](https://cosmoskit.com/).
The chain can also be accessed via JavaScript using the [`cosmjs` library](https://github.com/cosmos/cosmjs) (and [associated tutorials](https://tutorials.cosmos.network/tutorials/7-cosmjs/1-cosmjs-intro.html)), or using [CosmosKit](https://cosmology.zone/products/cosmos-kit).

## Chain resources

Expand All @@ -25,14 +20,6 @@ The chain can also be accessed via JavaScript using the [`cosmjs` library](https
- The base unit for staking is `ubld` (corresponding to `uatom` for Cosmos Hub)
- The command utility of the agoric chain is `agd` (corresponding to [`simd` for the Cosmos Hub](https://docs.cosmos.network/v0.45/run-node/interact-node.html)).
---
# Tools
## Building `agd`

The `agd` command line tool can be built as described in the Agoric [getting-started documentation](https://docs.agoric.com/guides/getting-started#build-the-cosmic-swingset-package). The linked step builds `agd`. To confirm that `agd` is in your `$PATH`, execute
```
agd version --long
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than deleting this section, how about adapting info from the Installing agd box in https://docs.agoric.com/guides/agoric-cli/agd-query-tx.html ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The info there does not say much about building agd though - it is about how to use an already built agd in docker container. Should I change the heading of the subsection to Installing agd too?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it has 2 options: a docker container or building from a release.

Maybe the thing to do is to keep this section as "Building agd" and make it mostly a pointer to https://github.com/Agoric/agoric-sdk/releases ; the docker option is probably less relevant here.

# FAQ

- How are transactions encoded?
Expand Down
4 changes: 2 additions & 2 deletions main/guides/zoe/contracts/otc-desk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

![Building a Composable DeFi Contract](./assets/title.jpg)

This is the OTC Desk contract from the ["Building a
This is the OTC Desk contract from the "Building a
Composable DeFi Contract" episode of Cosmos Code With
Us](https://cosmos.network/series/code-with-us/building-a-composable-defi-contract).
Us workshop.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rather than removing this link, I suggest pointing it to https://www.youtube.com/watch?v=e9dMkC2oFh8

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


[Watch the replay of the
workshop](https://www.youtube.com/watch?v=faxrecQgEio):
Expand Down
2 changes: 1 addition & 1 deletion main/reference/ertp-api/ertp-data-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ A **DisplayInfo** data type is associated with a **[Brand](./brand)** and gives
to display that **Brand**'s **[Amounts](#amount)**. **DisplayInfo** has one optional property,
**decimalPlaces**, which takes a non-negative integer value.

The **decimalPlaces** property tells the [display software](https://github.com/Agoric/agoric-sdk/tree/master/packages/ui-components)
The **decimalPlaces** property tells the [display software](https://github.com/Agoric/ui-kit)
how many places to move the decimal point over to the left so as to display the value
in the commonly used denomination (e.g., display "10.00 dollars" rather than "1000 cents").

Expand Down
2 changes: 0 additions & 2 deletions main/reference/zoe-api/zoe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,8 +364,6 @@ Every **Keyword** in **give** must have a corresponding **payment**.
const paymentKeywordRecord = harden({ Asset: quatloosPayment });
```

<a href="offerargs"></a>

Comment on lines -367 to -368
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can bring it back - does it serve any purpose?

Copy link
Member

@gibson042 gibson042 Jun 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, preserving old anchors allows any external links that use it to continue working (in this case, 45035c2 removed the "OfferArgs" heading but we still want its [formerly auto-generated] "offerargs" anchor to be associated with the replacement "Offer Arguments" heading). But you're right that there's a typo.

Suggested change
<a href="offerargs"></a>
<a id="offerargs"></a>

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

### Offer Arguments

**offerArgs** is an optional CopyRecord that can be used to pass additional arguments to the
Expand Down
Loading