Skip to content

How do we want to standardize our root-level documentation across (public) repos #52

@jdhoffa

Description

@jdhoffa

Very useful discussion thread with @mbarlow12 can be found here

In particular, with the rise of LLM-enhanced software development, especially in the open-source world, more and more of the .md documentation is meant to target (and improve) the results of tools like Claude.

At the same time, we still want documentation such as CONTRIBUTING.md, HACKING.md, CODE_OF_CONDUCT.md that is human-friendly and not overloaded with information.

This ticket serves as a discussion platform for determining the appropriate standard .md files to be found at the root-level of any given repo, and if it serves to have any additional separation for more comprehensive documentation targetting the robots

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions