Skip to content

As dev and end-user, I'll want a simpler and more helpful docs site (when the time comes) #177

@sgoumaz

Description

@sgoumaz

The current design is quite peculiar because of the lack of existing tooling at the time. It suffers from both dev and UX issues, among which (WIP):

  • Dev: Metalsmith-based structure and templates has grown a bit complicated and inconsistent with time (mix of Coffeescript and other templating languages…)
  • Dev: linkage with other repos can get hard to manage
  • Dev: manual build on separate GH pages repo (instead of automated on single repo)
  • UX: Absence of search and quick navigation expected nowadays
  • UX: Only the last API version is documented (no access to earlier versions of docs)

Tools that could help: Docusaurus, …

Metadata

Metadata

Assignees

No one assigned

    Labels

    📝 Design neededNeeds design work before implementation can be considered

    Type

    No type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions