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

feat(devx) - Navigation Changes #4048

Merged
merged 9 commits into from
Nov 15, 2024
Merged

Conversation

lucas-tortora
Copy link
Contributor

@lucas-tortora lucas-tortora commented Nov 14, 2024

Description of change

  • Added dedicated section for the Ts-SDK.
  • Created a section for SDKs & CLI in the developer section to grant more visibility
  • Removed the IOTA-101 category to give devs a quicker overview of topics.
  • Grouped all GraphQL dev docs together
  • Reorganized developer sidebar

Important Notice

I did not yet move the files to match the restructure, only altered the sidebar. If this new navigation is an improvement, we should update the files and folders to match.

Links to any relevant issues

Be sure to reference any related issues by adding fixes #(issue).

Type of change

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

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Describe the tests that you ran to verify your changes.

Make sure to provide instructions for the maintainer as well as any relevant configurations.

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

Release notes

Updated docs nav

@lucas-tortora lucas-tortora requested a review from a team as a code owner November 14, 2024 01:31
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 14, 2024
@lucas-tortora lucas-tortora added dx-documentation For TW or documentation related issues. devx Issues related to the DevX team labels Nov 14, 2024
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lucas-tortora lucas-tortora self-assigned this Nov 14, 2024
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

Copy link
Contributor

@salaheldinsoliman salaheldinsoliman left a comment

Choose a reason for hiding this comment

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

The changes are nice, but I have those two comments:
1- I think access on-chain time should be moved to Move Overview, it looks a bit "lonely" on the developer landing page
2- Subscribing to events on chain should belong to SDKs and CLI somehow, WDYT?

Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@Dr-Electron
Copy link
Contributor

I agree, nice changes. Lgtm

…anges

# Conflicts:
#	docs/content/sidebars/references.js
Copy link
Contributor

✅ Vercel Preview Deployment is ready!

View Preview

@lucas-tortora lucas-tortora merged commit 839d158 into develop Nov 15, 2024
33 of 34 checks passed
@lucas-tortora lucas-tortora deleted the devx/navigation-changes branch November 15, 2024 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation dx-documentation For TW or documentation related issues.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants