-
Notifications
You must be signed in to change notification settings - Fork 17
Docs: improve docs narrative around "ENSNode Plugins", "ENSDb Writers", and "ENSDb Readers". #2227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tk-o
wants to merge
33
commits into
main
Choose a base branch
from
docs/improve-ensdb-writer-reader-ensnode-plugins
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
a83d810
Update docs for Unigraph examples
tk-o 5ab3e68
Apply AI PR feedback
tk-o 3d9881c
Apply AI PR feedback
tk-o 22012e2
Merge remote-tracking branch 'origin/main' into docs/improve-unigraph…
tk-o 97ccdb4
Create dedicated pages
tk-o 15fc5b2
Udpate ENSNode Plugins page
tk-o d701b2e
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 2e61b46
Shift plugins narrative to focus on "ENSNode Plugins"
tk-o dc68c9a
Apply AI PR feedback
tk-o 799444a
Apply AI PR feedback
tk-o 4ffbc77
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o b9ad9ff
Apply AI PR feedback
tk-o 8e6910f
Fix sidebar link desc
tk-o 7078001
Apply suggestions from code review
tk-o 6b1904d
Apply suggestions from code review
tk-o 321a5b6
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o a8ab221
convert crlf to lf
tk-o 0a94011
Apply PR feedback
tk-o 8439521
Apply PR feedback
tk-o b278eff
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 9aa00be
Apply PR feedback
tk-o 3e5bb48
Add plugin info links
tk-o 3aa5d30
Apply AI PR feedback
tk-o ff7597e
Apply AI PR feedback
tk-o c6aa559
Apply AI PR feedback
tk-o ec6fabd
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 08cde59
Update references relator to "ENSDb Writer" and "ENSDb Reader"
tk-o 840e79e
Drop a temp design file
tk-o 2eecf14
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o fce23a4
Apply AI PR feedback
tk-o a28a838
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o 77ee770
Merge remote-tracking branch 'origin/main' into docs/improve-ensdb-wr…
tk-o d5d982f
Fix typo
tk-o File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
This file was deleted.
Oops, something went wrong.
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
27 changes: 27 additions & 0 deletions
27
docs/ensnode.io/src/components/molecules/EnsDbWriterSchemaIntro.astro
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| import { Aside } from "@astrojs/starlight/components"; | ||
|
|
||
| const { ensDbWriterSchemaName = "ensindexer_0" } = Astro.props; | ||
| --- | ||
|
|
||
| <Aside type="note" title="What is an ENSDb Writer Schema?"> | ||
| <p> | ||
| An <a href="/docs/services/ensdb/concepts/glossary#ensdb-writer-schema">ENSDb Writer Schema</a> is | ||
| a database schema within an <a href="/docs/services/ensdb/concepts/glossary#ensdb-instance" | ||
| >ENSDb instance</a | ||
| >, used to store indexed ENS data from a given <a | ||
| href="/docs/services/ensdb/concepts/glossary#ensdb-writer">ENSDb Writer</a | ||
| > instance. We use <code>{ensDbWriterSchemaName}</code> as the <a | ||
| href="/docs/services/ensdb/concepts/glossary#ensdb-writer-schema-name" | ||
| >ENSDb Writer Schema Name</a | ||
| > in examples on this page, but your <a | ||
| href="/docs/services/ensdb/concepts/glossary#ensdb-writer">ENSDb Writer</a | ||
| > instance may be configured to use a different schema name. Make sure to replace | ||
| <code>{ensDbWriterSchemaName}</code> with the actual schema name used by your ENSDb Writer instance | ||
| when querying the ENSDb instance directly. For example, <a | ||
| href="/docs/services/ensdb/concepts/glossary#ensindexer">ENSIndexer</a | ||
| > allows configuring its own ENSDb Writer Schema Name with the <code | ||
| >ENSINDEXER_SCHEMA_NAME</code | ||
| > environment variable. | ||
| </p> | ||
| </Aside> |
22 changes: 0 additions & 22 deletions
22
docs/ensnode.io/src/components/molecules/EnsIndexerSchemaIntro.astro
This file was deleted.
Oops, something went wrong.
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.