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

Improve Docs #273

Merged
merged 16 commits into from
Nov 13, 2024
Merged

Improve Docs #273

merged 16 commits into from
Nov 13, 2024

Conversation

madjin
Copy link
Collaborator

@madjin madjin commented Nov 12, 2024

Changes Made

  • Updated all docs post refactor codebase
  • Moved old docs into old folders just incase we want to compare
  • Added more mermaid charts to visualize architecture with
  • Restructured stream notes section in documentation for better organization and readability
  • Split up monolithic stream notes into individual pages with embedded YouTube videos
  • Added overview page to serve as stream notes index and navigation hub
  • Reorganized sidebar to better categorize streams by month
  • Created dedicated pages for:
    • Stream notes overview
    • Memes, AI Agents & DAOs (Nov 8)
    • Combined Discord development stream parts 1-4 (Nov 6)
    • October X Space sessions
  • Improved documentation readability by balancing emoji usage in sidebar
  • Added ⭐ to Quick Start guide to highlight entry point for new users
  • Added category for packages now

Testing

  • Check all internal documentation links
  • Confirm sidebar navigation functions as expected

@madjin
Copy link
Collaborator Author

madjin commented Nov 12, 2024

Just needs a logo then it's perfect imo
image

@madjin
Copy link
Collaborator Author

madjin commented Nov 12, 2024

Fixed a buncha broken links in the markdown files
image

@madjin
Copy link
Collaborator Author

madjin commented Nov 13, 2024

new frontpage + favicon added in as well
image

@twilwa twilwa merged commit 1422736 into main Nov 13, 2024
1 check failed
@twilwa twilwa deleted the docs branch November 13, 2024 05:19
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