Skip to content

Commit

Permalink
doc for query parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
gabros20 committed Aug 7, 2024
1 parent a34d65f commit da11183
Showing 1 changed file with 97 additions and 0 deletions.
97 changes: 97 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,100 @@ If the repo already exists locally:
- The server build environment requires Node.js [v18.17.0](https://nodejs.org/en/blog/release/v18.17.0) or higher
- For node modules installation, the `npm install --legacy-peer-deps` command should be defined in the node modules install config
- For cached fast builds, the `npm run build` command should be defined in the build config

### Build page query parameters for specific tabs

All possible combinations based on the data files. Let's break it down for each section:

1. Framework categories (from frameworks.js):

- All
- Ethereum
- Sovereign

2. Rollups categories (from rollups.js):

- All
- Arbitrum ORBIT
- OP Stack
- Polygon CDK
- Starknet Stack

#### Here are all possible query parameter combinations:

1. Single parameter combinations:

```
// Frameworks
?framework_category=All
?framework_category=Ethereum
?framework_category=Sovereign
// Rollups
?rollups_category=All
?rollups_category=Arbitrum%20ORBIT
?rollups_category=OP%20Stack
?rollups_category=Polygon%20CDK
?rollups_category=Starknet%20Stack
```

2. All possible combinations of both parameters:

```
?framework_category=All&rollups_category=All
?framework_category=All&rollups_category=Arbitrum%20ORBIT
?framework_category=All&rollups_category=OP%20Stack
?framework_category=All&rollups_category=Polygon%20CDK
?framework_category=All&rollups_category=Starknet%20Stack
?framework_category=Ethereum&rollups_category=All
?framework_category=Ethereum&rollups_category=Arbitrum%20ORBIT
?framework_category=Ethereum&rollups_category=OP%20Stack
?framework_category=Ethereum&rollups_category=Polygon%20CDK
?framework_category=Ethereum&rollups_category=Starknet%20Stack
?framework_category=Sovereign&rollups_category=All
?framework_category=Sovereign&rollups_category=Arbitrum%20ORBIT
?framework_category=Sovereign&rollups_category=OP%20Stack
?framework_category=Sovereign&rollups_category=Polygon%20CDK
?framework_category=Sovereign&rollups_category=Starknet%20Stack
```

3. Combinations with the possible IDs at the end to jump to sections in the same time.

```
?framework_category=All#build
?framework_category=All#integrate
?framework_category=All#deploy
?framework_category=Ethereum#build
?framework_category=Ethereum#integrate
?framework_category=Ethereum#deploy
// ...
?rollups_category=All#build
?rollups_category=All#integrate
?rollups_category=All#deploy
?rollups_category=Arbitrum%20ORBIT#build
?rollups_category=Arbitrum%20ORBIT#integrate
?rollups_category=Arbitrum%20ORBIT#deploy
// ...
?framework_category=All&rollups_category=All#build
?framework_category=All&rollups_category=All#integrate
?framework_category=All&rollups_category=All#deploy
?framework_category=All&rollups_category=Arbitrum%20ORBIT#build
?framework_category=All&rollups_category=Arbitrum%20ORBIT#integrate
?framework_category=All&rollups_category=Arbitrum%20ORBIT#deploy
// ...
```

**Remember that:**

1. These can be appended to the base URL: `https://celestia.org/build/`
2. You can add `#build` etc. id's at the end of any URL to anchor to the specific section.
3. Spaces in categories should be URL-encoded (%20) in actual use.

These combinations cover all possible states based on the data in the provided files. The implementation will default to "All" for any category if an invalid or non-existent category is provided in the URL parameters.

0 comments on commit da11183

Please sign in to comment.