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.

Sign up for GitHub

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

Jump to bottom

feat(docs) : Add Network Overview Page #3491

Merged
merged 39 commits into from
Nov 8, 2024
Merged

feat(docs) : Add Network Overview Page #3491

merged 39 commits into from
Nov 8, 2024

Conversation

vivekjain23
Copy link
Contributor

Description of change

Added Network Overview Page to the docs.

Links to any relevant issues

fixes #1614.

Type of change

Choose a type of change, and delete any options that are not relevant.

  • Enhancement (a non-breaking change which adds functionality)

How the change has been tested

Built locally.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@vivekjain23 vivekjain23 added documentation Improvements or additions to documentation dx-improvement Mainly for DX team itself to track issues with features/fixes that improve dx. Type: Documentation devx Issues related to the DevX team labels Oct 21, 2024
@vivekjain23 vivekjain23 marked this pull request as ready for review October 29, 2024 09:32
@vivekjain23 vivekjain23 requested a review from a team as a code owner October 29, 2024 09:32
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23 vivekjain23 requested a review from Thoralf-M October 29, 2024 10:21
@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 6, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@vivekjain23 @Thoralf-M
Fix faucet URL
377d3af 
Co-authored-by: Thoralf-M <[email protected]>
@vivekjain23
Copy link
Contributor Author

Thanks for the updates :) It's looking good to me, but I think there's still some improvements we can make:

  1. Could you add the network overview table in https://iota3-wiki-86224a49db5aefb63c2cbbbbdfdecbc9e1e90732-iatmrcpub.vercel.app/developer/
  2. Please add the devnet and testnet to the constants file (we can use placeholders for now), as in https://github.com/iotaledger/iota-wiki/blob/main/src/theme/constant.tsx. This way, we can call it as in https://github.com/iotaledger/iota-wiki/blob/main/docs/build/getting-started/networks-endpoints.mdx?plain=1#L41 , and we only need to update network information in one file.

sure Lucas, I have updated it in the next commits, Thanks for your suggestions.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 6, 2024

✅ Vercel Preview Deployment is ready!

View Preview

lucas-tortora
lucas-tortora requested changes Nov 6, 2024
View reviewed changes
Copy link
Contributor

@lucas-tortora lucas-tortora left a comment

Choose a reason for hiding this comment

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

Almost there :) Please add the devnet and testnet to the constants file (we can use placeholders for now), as in https://github.com/iotaledger/iota-wiki/blob/main/src/theme/constant.tsx. This way, we can call it as in https://github.com/iotaledger/iota-wiki/blob/main/docs/build/getting-started/networks-endpoints.mdx?plain=1#L41 , and we only need to update network information in one file.

docs/content/developer/developer.mdx Outdated Show resolved Hide resolved
docs/content/developer/getting-started/connect.mdx Outdated Show resolved Hide resolved
docs/content/developer/network-overview.mdx Outdated Show resolved Hide resolved
docs/content/developer/network-overview.mdx Outdated Show resolved Hide resolved
docs/content/developer/network-overview.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 7, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 7, 2024

✅ Vercel Preview Deployment is ready!

View Preview

lucas-tortora
lucas-tortora requested changes Nov 7, 2024
View reviewed changes
docs/site/src/components/constant.tsx Outdated Show resolved Hide resolved
docs/site/src/components/constant.tsx Outdated Show resolved Hide resolved
docs/content/developer/network-overview.mdx Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2024

✅ Vercel Preview Deployment is ready!

View Preview

Ginowine
Ginowine approved these changes Nov 8, 2024
View reviewed changes
Copy link
Contributor

@Ginowine Ginowine left a comment

Choose a reason for hiding this comment

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

LGTM

@vivekjain23 vivekjain23 merged commit 3cc3077 into develop Nov 8, 2024
31 of 32 checks passed
@vivekjain23 vivekjain23 deleted the devx/feat-network-overview-page branch November 8, 2024 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucas-tortora lucas-tortora lucas-tortora approved these changes

@Thoralf-M Thoralf-M Thoralf-M approved these changes

@Ginowine Ginowine Ginowine approved these changes

@salaheldinsoliman salaheldinsoliman Awaiting requested review from salaheldinsoliman

@Dr-Electron Dr-Electron Awaiting requested review from Dr-Electron

Assignees
No one assigned
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation dx-improvement Mainly for DX team itself to track issues with features/fixes that improve dx.
Projects
Developer Experience
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create network overview page
4 participants
@vivekjain23 @Ginowine @Thoralf-M @lucas-tortora