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

[Docs] Revamp #315

Closed
3 of 36 tasks
viktormarinho opened this issue May 3, 2024 · 3 comments
Closed
3 of 36 tasks

[Docs] Revamp #315

viktormarinho opened this issue May 3, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@viktormarinho
Copy link
Contributor

viktormarinho commented May 3, 2024

Docs revamp

The Documentation is currently in need of a list of fixes and some rewrites, a lot of it because of our new admin

This Issue will be used to keep track of all the mapped needed changes. Feel free to contribute!

  • Screenshots: We have a lot of screenshots using the old admin version. We probably want to replace them with the equivalent newer interface or create a nice way for versioning our documentation.
  • Broken images: There are some images with broken links. need to fix those.
  • Content:
    • Take time to read and rewrite some part of it, a lot has changed.
    • Would be nice to have short video tutorials on some pages.
    • I'd like to have a list of all matchers, each with a short video explaining them.
    • Replace any Excalidraw diagram with an on-brand one.
    • New overview page, coming soon

Task list

  • New overview page #333
  • Versioning
  • Update screenshots
  • Fix mobile navigation #331
  • Aside height/scroll seems buggy
  • Syntax Highlighting broken #318
  • Copy paste on code snippets #319
  • Content:
    • Deco
    • Deco Basics
    • Getting started
    • Sections
    • Pages
    • Loaders
    • Actions
    • Matchers & Segmentation (With a page and a video for each Matcher that comes by default in the project)
    • Apps
    • Themes
    • SEO #337
    • Analytics
    • Tracing
    • Partials
    • Async Rendering
    • Secrets
    • Performance: (a lot of pages as well)
    • Deco Architecture #329
    • Admin publish flow, how Deco <> Git works
    • Admin 2.0: Migration and common problems one could encounter
    • Developing locally (Env setup, Collaboration)
    • Roles & Permissions
    • Examples: Should be present in each of the upper files; and Copy Paste should compile & work for code snippets
    • Reference
      • Widgets
      • Annotations
      • Errors
      • Utility Types
@viktormarinho viktormarinho added documentation Improvements or additions to documentation enhancement New feature or request labels May 3, 2024
@viktormarinho viktormarinho pinned this issue May 7, 2024
@mcandeia
Copy link
Contributor

mcandeia commented May 7, 2024

  • Fix core web vitals "test" which is a broken link

@viktormarinho
Copy link
Contributor Author

  • Shopify docs with broken links

@matheusgr
Copy link
Contributor

matheusgr commented Jul 29, 2024

Revamp in another task force.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants