Skip to content

Commit

Permalink
fix(devx): Unified all documentation links to docs.iota.org (#4013)
Browse files Browse the repository at this point in the history
* fix(devx): use docs.iota.org for all Move doc links, and fix all absolute links

* fix(devx): use https

* Update docs/README.md

* dprint
  • Loading branch information
lucas-tortora authored Dec 5, 2024
1 parent a9b1232 commit aea6d7f
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 26 deletions.
2 changes: 1 addition & 1 deletion crates/iota-indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To run the indexer as a standalone service with an existing fullnode, follow the
cargo run --bin iota-indexer -- --db-url "postgres://postgres:postgrespw@localhost/iota_indexer" --rpc-client-url "https://fullnode.devnet.iota.io:443" --fullnode-sync-worker --reset-db
```

- to run indexer as a reader which exposes a JSON RPC service with following [APIs](https://docs.iota.io/iota-api-ref).
- to run indexer as a reader which exposes a JSON RPC service with following [APIs](https://docs.iota.org/iota-api-ref).

```
cargo run --bin iota-indexer -- --db-url "postgres://postgres:postgrespw@localhost/iota_indexer" --rpc-client-url "https://fullnode.devnet.iota.io:443" --rpc-server-worker
Expand Down
4 changes: 2 additions & 2 deletions crates/iota-json-rpc-api/src/indexer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ pub trait IndexerApi {
#[method(name = "queryEvents")]
async fn query_events(
&self,
/// The event query criteria. See [Event filter](https://docs.iota.io/build/event_api#event-filters) documentation for examples.
/// The event query criteria. See [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) documentation for examples.
query: EventFilter,
/// optional paging cursor
cursor: Option<EventID>,
Expand All @@ -78,7 +78,7 @@ pub trait IndexerApi {
#[subscription(name = "subscribeEvent", item = IotaEvent)]
fn subscribe_event(
&self,
/// The filter criteria of the event stream. See [Event filter](https://docs.iota.io/build/event_api#event-filters) documentation for examples.
/// The filter criteria of the event stream. See [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) documentation for examples.
filter: EventFilter,
) -> SubscriptionResult;

Expand Down
2 changes: 1 addition & 1 deletion crates/iota-json-rpc-api/src/transaction_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ pub trait TransactionBuilder {
function: String,
/// the type arguments of the Move function
type_arguments: Vec<IotaTypeTag>,
/// the arguments to be passed into the Move function, in [IotaJson](https://docs.iota.io/build/iota-json) format
/// the arguments to be passed into the Move function, in [IotaJson](https://docs.iota.org/references/iota-api) format
arguments: Vec<IotaJsonValue>,
/// gas object to be used in this transaction, node will pick one from the signer's possession if not provided
gas: Option<ObjectID>,
Expand Down
6 changes: 3 additions & 3 deletions crates/iota-open-rpc/spec/openrpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -4461,7 +4461,7 @@
"params": [
{
"name": "query",
"description": "The event query criteria. See [Event filter](https://docs.iota.io/build/event_api#event-filters) documentation for examples.",
"description": "The event query criteria. See [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) documentation for examples.",
"required": true,
"schema": {
"$ref": "#/components/schemas/EventFilter"
Expand Down Expand Up @@ -4705,7 +4705,7 @@
"params": [
{
"name": "filter",
"description": "The filter criteria of the event stream. See [Event filter](https://docs.iota.io/build/event_api#event-filters) documentation for examples.",
"description": "The filter criteria of the event stream. See [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) documentation for examples.",
"required": true,
"schema": {
"$ref": "#/components/schemas/EventFilter"
Expand Down Expand Up @@ -4921,7 +4921,7 @@
},
{
"name": "arguments",
"description": "the arguments to be passed into the Move function, in [IotaJson](https://docs.iota.io/build/iota-json) format",
"description": "the arguments to be passed into the Move function, in [IotaJson](https://docs.iota.org/references/iota-api) format",
"required": true,
"schema": {
"type": "array",
Expand Down
4 changes: 2 additions & 2 deletions crates/iota-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Unless otherwise specified, most of these examples assume `Rust` and `cargo` are

In the root folder of the `iota` repository (or in the `iota-sdk` crate folder), you can individually run examples using the command `cargo run --example filename` (without `.rs` extension). For example:

- `cargo run --example iota_client` -- this one requires a local Iota network running (see [#Connecting to Iota Network](https://docs.iota.org/developer/getting-started/local-network#start-a-local-network). If you do not have a local Iota network running, please skip this example.
- `cargo run --example iota_client` -- this one requires a local Iota network running (see [#Connecting to Iota Network](https://docs.iota.org/developer/getting-started/local-network#start-the-local-network). If you do not have a local Iota network running, please skip this example.
- `cargo run --example coin_read_api`
- `cargo run --example event_api` -- note that this will subscribe to a stream and thus the program will not terminate unless forced (Ctrl+C)
- `cargo run --example governance_api`
Expand All @@ -80,7 +80,7 @@ The `IotaClientBuilder` struct provides a connection to the JSON-RPC server that

For all available servers, see [here](https://docs.iota.org/developer/network-overview).

For running a local IOTA network, please follow [this guide](https://docs.iota.org/developer/getting-started/install-iota) for installing IOTA and [this guide](https://docs.iota.org/developer/getting-started/local-network#start-a-local-network) for starting the local IOTA network.
For running a local IOTA network, please follow [this guide](https://docs.iota.org/developer/getting-started/install-iota) for installing IOTA and [this guide](https://docs.iota.org/developer/getting-started/local-network#start-the-local-network) for starting the local IOTA network.

```rust
use iota_sdk::IotaClientBuilder;
Expand Down
2 changes: 1 addition & 1 deletion crates/iota-storage/src/object_store/http/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ use crate::object_store::{
http::{gcs::GoogleCloudStorage, local::LocalStorage, s3::AmazonS3},
};

// http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
// https://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html
//
// Do not URI-encode any of the unreserved characters that RFC 3986 defines:
// A-Z, a-z, 0-9, hyphen ( - ), underscore ( _ ), period ( . ), and tilde ( ~ ).
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ If you'd like to view the Vercel preview before your changes are ready for revie
IOTA is for the community. Contribute for the benefit of all.

- [Docs contributing guidelines](https://docs.iota.org/references/contribute/contribution-process)
- [Repo contributing guidelines](https://github.com/iotaledger/iota/blob/develop/CONTRIBUTING.md)
- [Style guide](https://docs.iota.org/style-guide)
- [Code of conduct](https://docs.iota.org/code-of-conduct)
- [Repo contributing guidelines](https://docs.iota.org/references/contribute/contribute-to-iota-repos)
- [Style guide](https://docs.iota.org/references/contribute/style-guide)
- [Code of conduct](https://docs.iota.org/references/contribute/code-of-conduct)

## License

Expand Down
1 change: 0 additions & 1 deletion docs/content/references/contribute/code-of-conduct.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: IOTA Contributor Covenant Code of Conduct
sidebar_label: Code of Conduct
slug: /code-of-conduct
---

IOTA, as an open-source project, encourages free discussion rooted in respect.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Contribute to IOTA Repositories
slug: /contribute-to-iota-repos
---

This page describes how to contribute to IOTA, and provides additional information about participating in the IOTA community.
Expand All @@ -13,7 +12,7 @@ To connect with the IOTA community, join our [Discord](https://discord.gg/iota).

To report an issue with IOTA, [create an issue](https://github.com/iotaledger/iota/issues/new/choose) in the GitHub repo. Click **Get started** to open a template for the type of issue to create.

## Fork IOTA to contribute
## Fork IOTA to Contribute

To contribute to IOTA source code or documentation, you need only a GitHub account. You can commit updates and then submit a PR directly from the Github website, or create a fork of the repo to your local environment and use your favorite tools to make changes. Always submit PRs to the `main` branch.

Expand Down
3 changes: 1 addition & 2 deletions docs/content/references/contribute/style-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Style Guide
slug: /style-guide
toc_max_heading_level: 2
---

Expand Down Expand Up @@ -556,7 +555,7 @@ Measurements should be written as numerals.
## Links

Always use relative links when linking to topics on docspnpm .iota.org.
Always use relative links when linking to topics on docs.iota.org.

Include the `.mdx` extension when creating internal links so that they also work from the source file in GitHub.

Expand Down
1 change: 1 addition & 0 deletions docs/content/sidebars/references.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ const references = [
items: [
'references/contribute/contribution-process',
'references/contribute/code-of-conduct',
'references/contribute/contribute-to-iota-repos',
'references/contribute/style-guide',
'references/contribute/add-a-quiz',
'references/contribute/import-code-docs',
Expand Down
10 changes: 5 additions & 5 deletions scripts/slipstream/config_slipstream.json
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
},
{
"regex": "docs\\.[Mm]ysten[Ll]abs\\.com",
"replacement": "wiki.iota.org"
"replacement": "docs.iota.org"
},
{
"regex": "\\{\\`\\$\\{new Date\\(\\)\\.getFullYear\\(\\)\\}\\s+Mysten\\s+Labs\\.\\s+All\\s+rights\\s+reserved\\.\\`\\}",
Expand Down Expand Up @@ -203,15 +203,15 @@
},
{
"regex": "sdk\\.[Mm]ysten[Ll]abs\\.com\/typescript",
"replacement": "wiki.iota.org/references/ts-sdk/typescript"
"replacement": "docs.iota.org/references/ts-sdk/typescript"
},
{
"regex": "sdk\\.[Mm]ysten[Ll]abs\\.com\/",
"replacement": "wiki.iota.org/references/ts-sdk/"
"replacement": "docs.iota.org/references/ts-sdk/"
},
{
"regex": "sdk\\.[Mm]ysten[Ll]abs\\.com",
"replacement": "wiki.iota.org/references/ts-sdk/typescript"
"replacement": "docs.iota.org/references/ts-sdk/typescript"
},
{
"regex": "[Mm]ysten[Ll]abs\\.com",
Expand Down Expand Up @@ -243,7 +243,7 @@
},
{
"regex": "docs\\.sui\\.io",
"replacement": "wiki.iota.org"
"replacement": "docs.iota.org"
},
{
"regex": "suiexplorer\\.com",
Expand Down
6 changes: 3 additions & 3 deletions sdk/typescript/src/client/types/params.ts
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ export interface GetValidatorsApyParams {}
/** Return list of events for a specified query criteria. */
export interface QueryEventsParams {
/**
* The event query criteria. See [Event filter](https://docs.iota.io/build/event_api#event-filters)
* The event query criteria. See [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters)
* documentation for examples.
*/
query: RpcTypes.IotaEventFilter;
Expand All @@ -353,7 +353,7 @@ export type QueryTransactionBlocksParams = {
export interface SubscribeEventParams {
/**
* The filter criteria of the event stream. See
* [Event filter](https://docs.iota.io/build/event_api#event-filters) documentation for examples.
* [Event filter](https://docs.iota.org/developer/iota-101/using-events#applying-event-filters) documentation for examples.
*/
filter: RpcTypes.IotaEventFilter;
}
Expand Down Expand Up @@ -413,7 +413,7 @@ export interface UnsafeMoveCallParams {
typeArguments: string[];
/**
* the arguments to be passed into the Move function, in
* [IotaJson](https://docs.iota.io/build/iota-json) format
* [IotaJson](https://docs.iota.org/references/iota-api) format
*/
arguments: unknown[];
/**
Expand Down

0 comments on commit aea6d7f

Please sign in to comment.