Skip to content
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

chore: Update v2 docs #239

Merged
merged 5 commits into from
Oct 18, 2024
Merged

chore: Update v2 docs #239

merged 5 commits into from
Oct 18, 2024

Conversation

samtin0x
Copy link
Contributor

No description provided.

@samtin0x samtin0x marked this pull request as ready for review September 17, 2024 11:10
rest_indexer=REST_URL,
websocket_indexer=WEBSOCKET_URL
node_url="dydx-ops-grpc.kingnodes.com:443", # No 'https://' prefix
rest_indexer="https://indexer.v4.dydx.exchange",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Christopher-Li are we okay with suggesting indexer endpoints via docs? if so this looks like a pretty solid upgrade from our current documentation

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@samtin0x i'd prefer if we keep these listed as variable names and instead link to https://docs.dydx.exchange/infrastructure_providers-network/resources#indexer-endpoints.

This will make the docs more durable to changes in indexer endpoints and also let developers know that they can set up their own indexer or node urls

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, both approaches work. As long as users/devs have a simple example they can copy paste and get quickstarted, as that has been the main blocker here, hence the PR

@samtin0x samtin0x force-pushed the samtin0x/update-v2-docs branch 2 times, most recently from eb2de48 to 3bfd0f8 Compare September 19, 2024 15:48
@yogurtandjam yogurtandjam changed the title Update v2 docs chore: Update v2 docs Sep 19, 2024
rest_indexer=REST_URL,
websocket_indexer=WEBSOCKET_URL
node_url="NODE_URL", # No 'https://' prefix
rest_indexer="REST_INDEXER",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] should still be descriptive of the data type REST_INDEXER_URL

therustmonk
therustmonk previously approved these changes Oct 18, 2024
Copy link
Contributor

@therustmonk therustmonk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect 🔥

@samtin0x samtin0x merged commit 2c92dc2 into main Oct 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants