Skip to content

Research about live, easily mainatanble documentation #3390

Open
@Michal-Kolomanski

Description

@Michal-Kolomanski

PoC in transformer https://transform-service.readthedocs.io/en/latest/schemas/modules.html

Goal:

  • The end goal is something similar to https://graph.openaire.eu/docs/apis/home
  • We want to document at least APIs and data models
  • It should be public
  • It should automatically rebuild itself on push
  • It should have a versioning

Scope:

  • Research about state of the art solution towards that in Rails

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions