Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-13413

Define a documentation strategy for module-specific docs

    • Type: Icon: Task Task
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Not Applicable
    • None
    • Storage Engines
    • 5
    • StorEng - 2024-09-03, StorEng - 2024-09-17, 2024-09-03 Q3 Streams v1

      The modularity team has agreed to investigate co-locating module-specific documentation with the module src code, while leaving WT API level docs in the src/docs folder.
      This ticket is to look into options for how this content would be structured.

      This ticket should:

      • Review documentation options; Do we extend our use of Doxygen? Do we define a README.md file? Do we use an alternate file format? (AsciiDoc https://asciidoc.org/ and reStructedText https://docutils.sourceforge.io/rst.html have both been suggested)
      • Demonstrate a proof of concept for the proposed implementation(s) that can be demonstrated to the team. This doesn't require documentation, just the folder structure and - if required by the implementation - an example of the docs compiling

            Assignee:
            Unassigned Unassigned
            Reporter:
            andrew.morton@mongodb.com Andrew Morton
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: