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

Restructure #554

Merged
merged 31 commits into from
May 15, 2024
Merged

Restructure #554

merged 31 commits into from
May 15, 2024

Conversation

jlwllmr
Copy link
Collaborator

@jlwllmr jlwllmr commented Apr 26, 2024

Implements a restructure of the docs to improve navigability and ease of use, addressing some unwieldy categorisation that has arisen over time and successive iterations of the site.

File changes mainly involve:

  • Changes to location in directory structure;
  • Fixing internal links;
  • Adds index pages with cards where necessary;
  • Updates to sidebars.js to account for these changes, and;
  • Adding redirects to docusaurus.config.js.

Main features:

  • Navbar headings simplified and navbar generally cleaned up. Release notes link added there rather than the sidebar.
  • Homepage cards updated for relevancy.
  • Moved many items from the user and developer sidebars to the footer and elsewhere to reduce clutter.
  • Addressed orphan files by moving them to appropriate directories.
  • Re-added sidebar visibility for Linea SDK.
  • Improved visibility and cohesiveness of Linea Voyage content by adding a directory devoted to it.
  • Generally attempted to group items by use case and intended purpose, rather than with more abstract themes or other methods. E.g. Much user-focussed content is now consolidated under the "Move funds to Linea" heading, and much dev content is now grouped under "Guides".

Copy link

vercel bot commented Apr 26, 2024

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

Name Status Preview Comments Updated (UTC)
doc-zk-evm ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2024 9:16am

This reverts commit 759cea9.
@jlwllmr jlwllmr marked this pull request as ready for review April 29, 2024 10:17
@jlwllmr jlwllmr requested review from bgravenorst, mapachurro and emilyJLin95 and removed request for bgravenorst and mapachurro April 29, 2024 10:17
@jlwllmr jlwllmr changed the title [DO NOT MERGE] Restructure Restructure Apr 29, 2024
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
@jlwllmr jlwllmr merged commit 6c1070e into main May 15, 2024
7 checks passed
@jlwllmr jlwllmr deleted the restructure branch May 15, 2024 09:17
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.

None yet

3 participants