manual, set internal collections to filename.md template

This commit is contained in:
Mik-TF
2024-05-13 19:28:23 -04:00
parent 280652166f
commit 1836179a75
169 changed files with 709 additions and 709 deletions

View File

@@ -45,11 +45,11 @@ The main structure of the code base is as follows:
Adding a new endpoint should be accompanied with a corresponding test. Ideally every change or bug fix should include a test to ensure the new behavior/fix is working as intended.
Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](./db_testing.md) for more information about how to prepare your db.
Since these are integration tests, you need to first make sure that your local db is already seeded with the ncessary data. See tools [doc](db_testing.md) for more information about how to prepare your db.
Testing tools offer two clients that are the basic of most tests:
- `local`: this client connects to the local db
- `proxy client`: this client connects to the running local instance
You need to start an instance of the server before running the tests. Check [here](./commands.md) for how to start.
You need to start an instance of the server before running the tests. Check [here](commands.md) for how to start.

View File

@@ -50,7 +50,7 @@ By default, the instance runs against devnet. to configure that you will need to
3. **Docker**: Containerize the running services such as Postgres and Redis.
4. **Mnemonics**: Secret seeds for adummy identity to use for the relay client.
For more about the prerequisites and how to set up and configure them. follow the [Setup guide](./setup.md)
For more about the prerequisites and how to set up and configure them. follow the [Setup guide](setup.md)
<!-- Development -->
@@ -90,7 +90,7 @@ To start the services for development or testing make sure first you have all th
make docs
```
To run in development environment see [here](./db_testing.md) how to generate test db or load a db dump then use:
To run in development environment see [here](db_testing.md) how to generate test db or load a db dump then use:
```sh
go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --postgres-host 127.0.0.1 --postgres-db tfgrid-graphql --postgres-password postgres --postgres-user postgres --mnemonics <insert user mnemonics>
@@ -98,7 +98,7 @@ go run cmds/proxy_server/main.go --address :8080 --log-level debug -no-cert --po
Then visit `http://localhost:8080/<endpoint>`
For more illustrations about the commands needed to work on the project, see the section [Commands](./commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](./contributions.md).
For more illustrations about the commands needed to work on the project, see the section [Commands](commands.md). For more info about the project structure and contributions guidelines check the section [Contributions](contributions.md).
<!-- Production-->

View File

@@ -14,12 +14,12 @@ To assist you on your journey, we have organized the content into distinct chapt
<h2>Table of Contents</h2>
- [Introducing Grid Proxy](./proxy.md)
- [Setup](./setup.md)
- [DB Testing](./db_testing.md)
- [Commands](./commands.md)
- [Contributions](./contributions.md)
- [Explorer](./explorer.md)
- [Database](./database.md)
- [Production](./production.md)
- [Release](./release.md)
- [Introducing Grid Proxy](proxy.md)
- [Setup](setup.md)
- [DB Testing](db_testing.md)
- [Commands](commands.md)
- [Contributions](contributions.md)
- [Explorer](explorer.md)
- [Database](database.md)
- [Production](production.md)
- [Release](release.md)