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

doc: Improve the overall deployment documentation #869

Open
wants to merge 7 commits into
base: dev
Choose a base branch
from

Conversation

Tomiwa1
Copy link

@Tomiwa1 Tomiwa1 commented Jan 4, 2025

What does this PR do?

Updates documentation

Related ticket

Fixes #862

Type of change

  • Chore
  • Bug fix
  • New feature
  • Documentation update

Check list

  • Unit tests for any smart contract change
  • Contracts and functions are documented

@alainncls alainncls changed the title Update current documentation doc: Improve the overall deployment documentation Jan 6, 2025
@alainncls
Copy link
Collaborator

Thanks a lot for this contribution @Tomiwa1 🙏
I've asked @arthur-remy to review the changes from a product perspective.
Also, I know the integration tests are failing, but don't worry, that's on me 😉

@Tomiwa1
Copy link
Author

Tomiwa1 commented Jan 6, 2025

It's my pleasure. You can assign me to the remaining documentation issues, I'll take a look at them.

@arthur-remy
Copy link
Collaborator

arthur-remy commented Jan 21, 2025

Thanks a lot for your contribution @Tomiwa1 and sorry for the delay to review.
It's a great improvement to add tables to store deployment addresses. Adding the introduction and some of the other text changes don't feel as impactful as it adds some verbose from my perspective.

I suggest to do the following:

  • Keep the great address table but split them into two tables, one for mainnets, the other for testnets, make the testnet one collapsible to save space
  • A nice addition would be to add a short description of the role of each contract before the table as well
  • Put "legacy" subgraph v1 url in a collapsible section to save space as well
  • Deployment are useful but can probably be put in a dedicated .md file and just linked in the main REAME to save space

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] Improve the overall deployment documentation
3 participants