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

Minimal restructure to demo Concept/How To/Reference/Tutorial approach #420

Merged
merged 9 commits into from
Feb 9, 2025

Conversation

MadelineAu
Copy link
Contributor

@MadelineAu MadelineAu commented Feb 5, 2025

@wesfloyd - put together this draft PR to show how a Concept/HowTo/Reference/Tutorial restructure would look. It's very minimal so far - only moves and renames topics. I wanted to get your thoughts before going any further and putting redirects in place.

The diffs won't be great for seeing what I'm trying to do - you'll probably need to pull the branch and build locally.

Copy link

vercel bot commented Feb 5, 2025

@MadelineAu is attempting to deploy a commit to the EigenLabs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Feb 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
eigenlayer-docs ✅ Ready (Inspect) Visit Preview Feb 9, 2025 11:09pm

@wesfloyd
Copy link
Collaborator

wesfloyd commented Feb 5, 2025

image

@wesfloyd
Copy link
Collaborator

wesfloyd commented Feb 5, 2025

@MadelineAu Overall I'm a fan of the new organization - it feels very reasonably and logically organized. I don't see any red flags and in general I want to defer to you preference where possible.

It might be good to double check with Nader in case he'd like to weigh in as a next step? Some of the current design decisions were with his guidance in the interests of new developers.

Tactical feedback:

  • I needed to fix a few URLs in order for it to build properly. f7c9d9a
  • If/when we move forward with these changes - we may want to create new redirects from the old links to the new links. Otherwise external links used in many places would lead to 404.
  • Maybe we move Security to "Reference" or a lower section since it hasn't been reviewed in 6 months'ish and is less necessary for first time builders?

@dabit3
Copy link
Collaborator

dabit3 commented Feb 6, 2025

A couple of thoughts:

  1. I really like this structure, I think it's definitely more intuitive
  2. I wonder if the change in language from "AVS Dashboard Onboarding" to "Implement AVS Marketplace Interfaces" could be confusing as most of the inbound we have for this documentation usually revolves around wanting to be listed on the dashboard
  3. From my understanding, the quickstart guide is one of the most useful pieces of documentation we have, I wonder if we can have it somewhere more prominent

@MadelineAu
Copy link
Contributor Author

Thanks for the feedback @wesfloyd and @dabit3. Addressed as follows:

  1. Created (and fixed...) redirects.
  2. Moved Security page to Reference.
  3. Updated to Onboard to AVS Dashboard
  4. Moved Quickstart in to "How To -> Get Started". Could consider breaking the framework to add a 'get started' section above 'Concepts' if that makes sense.

Copy link
Collaborator

@wesfloyd wesfloyd left a comment

Choose a reason for hiding this comment

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

lgtm

@MadelineAu MadelineAu merged commit 1684eb2 into Layr-Labs:main Feb 9, 2025
1 check passed
@MadelineAu MadelineAu deleted the devRestruture branch February 9, 2025 23:46
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.

3 participants