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 documentation #1349

Closed
5 of 7 tasks
ch1bo opened this issue Mar 11, 2024 · 3 comments · Fixed by #1419
Closed
5 of 7 tasks

Restructure documentation #1349

ch1bo opened this issue Mar 11, 2024 · 3 comments · Fixed by #1419
Labels
documentation 📖 Documentation changes task Subtask of a bigger feature.
Milestone

Comments

@ch1bo
Copy link
Member

ch1bo commented Mar 11, 2024

Why

The documentation is currently quite fragmented and not consistent between user and developer documentation.

To improve upon this, we want to analyse and test a different structure with improved user journey / experience.

What

As a first step we outlined a better distribution of sections in this sitemap draft:

  • Create a branch with an outline matching what is currently in the draft
  • Meet with tech writers Monday 2024-03-18
  • Create / move pages according to outline, but only with placeholders content with one sentence "what this page will be about"
  • Meet again to speak about the landing page
  • Implement the documentation changes
    • Try that prominent entry pages (according to our analystics) are still using the same URL or are redirected

Maybe out of scope / follow-up

  • Adopt / integrate a provided landing page design + content
@ch1bo ch1bo added task Subtask of a bigger feature. documentation 📖 Documentation changes labels Mar 11, 2024
@ch1bo ch1bo self-assigned this Mar 18, 2024
@ch1bo
Copy link
Member Author

ch1bo commented Mar 18, 2024

Drafted and discussed this clustering today and added some notes / aiken inspiration to the landing page:

Untitled-2024-03-18-1339 excalidraw

Current changes on https://github.com/input-output-hk/hydra/tree/docs-restructure

@ch1bo ch1bo removed their assignment Mar 18, 2024
@ch1bo
Copy link
Member Author

ch1bo commented Apr 15, 2024

Collected new landing page contents (at IOG) in this document: https://docs.google.com/document/d/1CvwS_aGJlzQcJbeRp-F_jAJ3TytF1WbLUJ1yaKsoIbM/edit#heading=h.qd4d3g5btn2t

We'll be looking for someone creative at IOG or independent to design a landing page (markup + stylesheets) around this.

@ch1bo ch1bo added this to the 0.17.0 milestone Apr 15, 2024
@ch1bo ch1bo mentioned this issue Apr 17, 2024
4 tasks
@ch1bo ch1bo self-assigned this May 3, 2024
@ch1bo
Copy link
Member Author

ch1bo commented May 6, 2024

Started work on this, some more sub-tasks to keep track off

  • Convert demo to tutorial
  • Provide a good intro to /docs
  • Simplify installation & configuration in docs
  • Groom how-tos
  • Complete intro to /docs/dev
  • Remove glossary
  • (optional?) Convert coding standards to ADR-like blog?
  • (optional?) Convert testing strategy to docs page
  • (optional?) Add media pack

@ch1bo ch1bo linked a pull request May 8, 2024 that will close this issue
4 tasks
@ch1bo ch1bo removed their assignment May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Documentation changes task Subtask of a bigger feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant