Skip to content

Commit

Permalink
Fix broken links to config options (#30)
Browse files Browse the repository at this point in the history
Nested README.md files are not linked correctly, so we rename them
to index.md.
  • Loading branch information
sealer3 authored Jan 6, 2025
1 parent 41b361f commit 2506740
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 43 deletions.
4 changes: 2 additions & 2 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@
- [Assets server](./install/assets-server.md)
- [Validating the installation](./install/validating.md)
- [Configuration](./config/README.md)
- [Specifying the configuration](./config/reading/README.md)
- [Specifying the configuration](./config/reading/index.md)
- [Development](./config/reading/devel.md)
- [Production](./config/reading/prod.md)
- [Options](./config/options/README.md)
- [Options](./config/options/index.md)
- [Branding](./config/options/branding.md)
- [Optimism](./config/options/optimism.md)
- [Price oracles](./config/options/oracles.md)
Expand Down
4 changes: 2 additions & 2 deletions src/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

In this chapter we first explain how the application configuration is read.

- [Specifying the configuration](./reading/README.md)
- [Specifying the configuration](./reading/index.md)

Then we explore all the available configuration options.

- [Configuration options](./options/README.md)
- [Configuration options](./options/index.md)
20 changes: 0 additions & 20 deletions src/config/options/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1 @@
# Options

Otterscan can be customized in many different ways.

- [Branding](./branding.md)

If your chain is an Optimism L2 Superchain, you can wire that Otterscan instance with an L1 one.

- [Optimism](./optimism.md)

Price resolvers can be customized as well.

- [Price oracles](./oracles.md)

If you are running Otterscan against a non-standard chain, but you are sure Erigon can run it, you can explicitly specify the configuration.

- [Recognizing nonstandard chains](./chains.md)

In case you are running your own Sourcify instance, that's configurable as well.

- [Alternative Sourcify sources](./sourcify.md)
21 changes: 21 additions & 0 deletions src/config/options/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Options

Otterscan can be customized in many different ways.

- [Branding](./branding.md)

If your chain is an Optimism L2 Superchain, you can wire that Otterscan instance with an L1 one.

- [Optimism](./optimism.md)

Price resolvers can be customized as well.

- [Price oracles](./oracles.md)

If you are running Otterscan against a non-standard chain, but you are sure Erigon can run it, you can explicitly specify the configuration.

- [Recognizing nonstandard chains](./chains.md)

In case you are running your own Sourcify instance, that's configurable as well.

- [Alternative Sourcify sources](./sourcify.md)
19 changes: 0 additions & 19 deletions src/config/reading/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1 @@
# Specifying the configuration

There are multiple ways to configure Otterscan base settings, depending on how you want to run it.

## Static hardcoded node/chain ID

Define a `VITE_CONFIG_JSON` environment variable containing a JSON string with the entire config.

- [During development time](./devel.md)
- [For production](./prod.md)

## Fetch config from server

If you don't specify a `VITE_CONFIG_JSON` variable, the dapp will fetch a `<your-domain>/config.json` file on page load.

That file can be overwritten server-side and changes will be reflected when users refresh the page.

You are free to define the best way to do that depending on how you package your Otterscan distribution.

For reference, our official Docker image accepts initialization parameters that overwrite that file when the container is initialized.
20 changes: 20 additions & 0 deletions src/config/reading/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Specifying the configuration

There are multiple ways to configure Otterscan base settings, depending on how you want to run it.

## Static hardcoded node/chain ID

Define a `VITE_CONFIG_JSON` environment variable containing a JSON string with the entire config.

- [During development time](./devel.md)
- [For production](./prod.md)

## Fetch config from server

If you don't specify a `VITE_CONFIG_JSON` variable, the dapp will fetch a `<your-domain>/config.json` file on page load.

That file can be overwritten server-side and changes will be reflected when users refresh the page.

You are free to define the best way to do that depending on how you package your Otterscan distribution.

For reference, our official Docker image accepts initialization parameters that overwrite that file when the container is initialized.

0 comments on commit 2506740

Please sign in to comment.