Skip to content

build docs from editor notes using OAK #159

@StroemPhi

Description

@StroemPhi

I'm using the IAO:'editor note' for the documentation of design decisions because I want this info to be attached to the source code. In order to have this documentation also in the docs generated by ODK, it seems like a good idea to use OAK to automatically read out all those editor notes and automatically convert them into the markdown files. The idea for this was to create a Python script that will be called from the custom makefile in the build process.

TODO:

  • make venv for testing this with OAK locally
  • create "docs_from_notes.py"
  • find out how to call the py from the makefile and how to integrate it into the automatic docs build workflow
  • share the insights with OAK and ODK devs

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions