Skip to content

Commit

Permalink
docs: Update apps-config README fixing some broken links (polkadot-js…
Browse files Browse the repository at this point in the history
  • Loading branch information
ltfschoen authored Apr 1, 2020
1 parent 820cc08 commit e257974
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions packages/apps-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
General config for various services, including settings, external links & types. This is a central source of all the configuration settings that can be tweaked. This also means that it can be customized (via PR) to support any additional chains. The internals are split into a number of settings -

- [api](./src/api) - Here you can add any chain or node-type specific types configuration. When added, it means that when the UI connects to either a runtime with a spec name, or a chain with a specific name, the types will be automatically added to the API as used in the app.
- [links](./src/links) - These are all links to external providers such as explorers. This information is used anywhere where there is an external lik to determine the providers for these links.
- [links](./src/links) - These are all links to external providers such as explorers. This information is used anywhere where there is an external link to determine the providers for these links.
- [settings](./src/settings) - These are used in dropdowns, specifically under the settings page.
- [ui](./src/ui) - Logos & color settings for chain and node spec specific overrides. This means that when the runtime/chain is detected, the specific logo would be used.

Expand All @@ -13,8 +13,8 @@ Customization for each of these are discussed next.

The API config can be done in one of two ways -

- [chain](./api/chain) - Here we are mapping to a specific chain name. Generally the next type would be preferred, however if you are supporting multiple chains with individual config, you would probably want to add the chain-specific information in here.
- [spec](./api/spec) - Here we are mapping from the runtime spec name of the chain to specific types. This means that when connected to a specific spec, these types will be injected.
- [chain](./src/api/chain) - Here we are mapping to a specific chain name. Generally the next type would be preferred, however if you are supporting multiple chains with individual configs, you would probably want to add the chain-specific information in here.
- [spec](./src/api/spec) - Here we are mapping from the runtime spec name of the chain to specific types. This means that when connected to a specific spec, these types will be injected.

The actual type definitions you should be familiar with, it is exactly the same as you would upload via the settings page in JSON, or as detailed in the [API types pages](https://polkadot.js.org/api/start/types.extend.html#extending-types).

Expand All @@ -26,18 +26,18 @@ We are not going to spend too much time here, since it is generally applicable t

There are 2 general areas of interest here -

- [endpoints](./settings/endpoints) - This is where we can add additional endpoints to appear in the dropdowns. We would like to keep this to mostly live networks, although based on demand can probably extend to a testing-only section as well.
- [ss58](./settings/ss58) - Should you wish to add your ss58Format to the settings dropdown, this is where the configuration take place
- [endpoints](./src/settings) - This is where we can add additional endpoints to appear in the dropdowns. We would like to keep this to mostly live networks, although based on demand can probably extend to a testing-only section as well.
- [ss58](./src/settings) - Should you wish to add your ss58Format to the settings dropdown, this is where the configuration take place

## UI

These are self-explanatory and config here actually does get used in other parts such as well. Basically the information here is broken down into a couple of catagories -
These are self-explanatory and config here actually does get used in other parts as well. Basically the information here is broken down into a couple of categories -

- general
- [general](./src/ui/general)
- color configuration based on chain
- identityIcon
- [identityIcon](./src/ui/identityIcons)
- specific identityIcon to use based on node name
- logos
- [logos](./src/ui/logos)
- chains - Specific logos when connecting to a specific chain
- nodes - Logos that are used when connecting to a specific runtime spec type (catch-all)
- named - These logos are used [settings](./settings)
- named - These logos are used as overrides when we pass an explicit logo name

0 comments on commit e257974

Please sign in to comment.