Refine ENSRainbow Docs #1075
Open
Refine ENSRainbow Docs #1075
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 9d7b12b The changes in this PR will be included in the next version bump. This PR includes changesets to release 14 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
djstrong
added
documentation
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@djstrong Here's some quick feedback on enhanced patterns we could use.
docs/ensnode.io/src/content/docs/ensrainbow/concepts/glossary.mdx
Outdated
Show resolved
Hide resolved
docs/ensnode.io/src/content/docs/ensrainbow/concepts/glossary.mdx
Outdated
Show resolved
Hide resolved
docs/ensnode.io/src/content/docs/ensrainbow/concepts/label-sets-and-versioning.mdx
Outdated
Show resolved
Hide resolved
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
| variable "ensindexer_label_set_id" { | ||
| type = string | ||
| description = "The label set ID that ENSIndexer will request from ENSRainbow for deterministic label healing (e.g., 'subgraph', 'ens-test-env')" | ||
| description = "The label set ID that ENSIndexer will request from ENSRainbow for deterministic label healing. See https://ensnode.io/ensrainbow/concepts/glossary/#label_set_id for definition." |
There was a problem hiding this comment.
The anchor fragments in the glossary URLs use underscores instead of hyphens, causing broken links to the documentation.
View Details
📝 Patch Details
diff --git a/terraform/variables.tf b/terraform/variables.tf
index 173d2b8..f690d77 100644
--- a/terraform/variables.tf
+++ b/terraform/variables.tf
@@ -85,21 +85,21 @@ variable "ethereum_holesky_rpc_url" {
# The "fully pinned" label set reference that ENSIndexer will request ENSRainbow use for deterministic label healing across time. This label set reference is "fully pinned" as it requires both the labelSetId and labelSetVersion fields to be defined.
variable "ensindexer_label_set_id" {
type = string
- description = "The label set ID that ENSIndexer will request from ENSRainbow for deterministic label healing. See https://ensnode.io/ensrainbow/concepts/glossary/#label_set_id for definition."
+ description = "The label set ID that ENSIndexer will request from ENSRainbow for deterministic label healing. See https://ensnode.io/ensrainbow/concepts/glossary/#label-set-id for definition."
}
variable "ensindexer_label_set_version" {
type = string
- description = "The label set version that ENSIndexer will request from ENSRainbow for deterministic label healing. See https://ensnode.io/ensrainbow/concepts/glossary/#label_set_version for definition."
+ description = "The label set version that ENSIndexer will request from ENSRainbow for deterministic label healing. See https://ensnode.io/ensrainbow/concepts/glossary/#label-set-version for definition."
}
# Label set that ENSRainbow will offer to its clients
variable "ensrainbow_label_set_id" {
type = string
- description = "The label set ID that ENSRainbow will offer to its clients. See https://ensnode.io/ensrainbow/concepts/glossary/#label_set_id for definition."
+ description = "The label set ID that ENSRainbow will offer to its clients. See https://ensnode.io/ensrainbow/concepts/glossary/#label-set-id for definition."
}
variable "ensrainbow_label_set_version" {
type = string
- description = "The highest label set version that ENSRainbow will offer to its clients. See https://ensnode.io/ensrainbow/concepts/glossary/#label_set_version for definition."
+ description = "The highest label set version that ENSRainbow will offer to its clients. See https://ensnode.io/ensrainbow/concepts/glossary/#label-set-version for definition."
}
Analysis
Incorrect anchor fragments in terraform glossary URLs break documentation links
What fails: terraform/variables.tf uses underscores in glossary anchor links (#label_set_id, #label_set_version) instead of hyphens, causing broken links to documentation
How to reproduce:
- Navigate to any URL like
https://ensnode.io/ensrainbow/concepts/glossary/#label_set_id - Link returns 404/anchor not found since actual anchors use hyphens
Result: Broken documentation links in terraform variable descriptions on lines 88, 93, 99, and 104
Expected: Working links using #label-set-id and #label-set-version per GitHub slugger rules (spaces become hyphens in anchors) and Astro documentation (uses github-slugger for heading IDs)
…s, adding references to the glossary for clarity. Update environment variable descriptions in `.env.local.example` files and improve comments in scripts to ensure consistent understanding of label set concepts.
…ipts to enhance clarity on label sets and versions. Add glossary references for better understanding across multiple files.
…criptions in Terraform variables for clarity on label sets and versions. Add references to the glossary for improved understanding.
…sh and add references to the ENSRainbow Glossary for comprehensive understanding.
…l" in the ENSRainbow overview and API client comments, improving clarity and user understanding.
…rd" in multiple files, improving clarity and user understanding of the data model and related concepts.
…VERSION references and enhancing clarity in environment variable definitions. Update examples for consistency and improve overall readability.
…set reference links, ensuring consistency and clarity in documentation. Enhance user understanding of environment variables related to label sets.
Updated the URL for the labelhash glossary reference.
…creating `.ensrainbow` files from both SQL and CSV sources. Update the description of the `searchlight` label set to reflect its availability and improved dataset features. Revise performance metrics for the `searchlight` dataset and include usage examples for downloading the extended discovery dataset.
djstrong
force-pushed
the
932-refine-ensrainbow-docs
branch
from
1e511aa to
9d7b12b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deduplication of terms as part of issue #932