Skip to content

Commit

Permalink
Address #579 by re-adding index pages on offending sections
Browse files Browse the repository at this point in the history
  • Loading branch information
deekerno committed Mar 16, 2023
1 parent 58910a6 commit 5cdf8f6
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 61 deletions.
6 changes: 3 additions & 3 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Getting Started

- [Dependencies](./getting-started/dependencies/fuelup.md)
- [Dependencies](./getting-started/dependencies/index.md)
- [`fuelup`](./getting-started/dependencies/fuelup.md)
- [Database](./getting-started/dependencies/database.md)
- [WASM](./getting-started/dependencies/wasm.md)
Expand Down Expand Up @@ -36,11 +36,11 @@
- [TransferOut](./reference-guide/indexing/receipts/transferout.md)
- [ScriptResult](./reference-guide/indexing/receipts/scriptresult.md)
- [Data Types](./reference-guide/data-types/types.md)
- [GraphQL](./reference-guide/components/graphql/schema.md)
- [GraphQL](./reference-guide/components/graphql/index.md)
- [Schema](./reference-guide/components/graphql/schema.md)
- [Directives](./reference-guide/components/graphql/directives.md)
- [API Server](./reference-guide/components/graphql/api-server.md)
- [Database](./reference-guide/components/database/foreign-keys.md)
- [Database](./reference-guide/components/database/index.md)
- [Foreign Keys](./reference-guide/components/database/foreign-keys.md)
- [ID Types](./reference-guide/components/database/ids.md)
- [Plugins](./reference-guide/plugins/index.md)
Expand Down
50 changes: 0 additions & 50 deletions docs/src/getting-started/dependencies.md

This file was deleted.

13 changes: 13 additions & 0 deletions docs/src/getting-started/dependencies/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Dependencies

To run the Fuel indexer, you'll need to install a few dependencies on your system:

- [`fuelup`](./fuelup.md), the Fuel toolchain manager
- a supported [database](./database.md)
- We support Postgres at this time
- the [`wasm32-unknown-unknown`](./wasm.md) Rust compilation target
- [`wasm-snip`](./wasm.md), a utility for trimming WebAssembly binaries

If you don't want to install a database directly onto your system, you can use Docker to run it as an isolated container. You can install it by following the [install instructions](https://docs.docker.com/get-docker/). For reference purposes, we provide a [`docker compose` file](https://github.com/FuelLabs/fuel-indexer/blob/master/scripts/docker-compose.yaml) that runs a Postgres database and the Fuel indexer service.

Also, it's assumed that you have the Rust programming language installed on your system. If that is not the case, please refer to the [Rust installation instructions](https://www.rust-lang.org/tools/install) for more information.
9 changes: 4 additions & 5 deletions docs/src/reference-guide/components/database/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# Database

The Fuel indexer uses [Postgres](https://github.com/docker-library/postgres/blob/2f6878ca854713264ebb27c1ba8530c884bcbca5/14/bullseye/Dockerfile) as the primary database.
.
The Fuel indexer uses [PostgreSQL](https://github.com/docker-library/postgres/blob/2f6878ca854713264ebb27c1ba8530c884bcbca5/14/bullseye/Dockerfile) as the primary database. We're open to supporting other storage solutions in the future.

In this section, you can find information regarding how your data should be structured for use in the Fuel indexer:

- [Types](./types.md)
- How to use different data types from your Sway contract, all the way to your Postgres table
- [Foreign Keys](./foreign-keys.md)
- How foreign keys are handled in GraphQL schema, and Postgres.
- How foreign keys are handled in the Fuel indexer.
- [⚠️ IDs](./ids.md)
- Explains some conventions surrounding the usage of `ID` types
1 change: 0 additions & 1 deletion docs/src/reference-guide/components/database/types.md

This file was deleted.

5 changes: 3 additions & 2 deletions docs/src/reference-guide/components/graphql/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# GraphQL

The Fuel indexer uses GraphQL to in order to allow users to query for indexed data. Please note that the Fuel indexer does not support the full GraphQL specification; however, we do our best to reasonably support as much as we can. In this chapter, you can find information on how to leverage our supported features to efficiently get the data you want.

- [GraphQL API Server](./api-server.md)
- [Directives](./directives.md)
- [Schema](./../assets/schema.md.md)
- [Types](./../database/types.md)
- [Schema](./schema.md)

0 comments on commit 5cdf8f6

Please sign in to comment.