Skip to content

Bug: The top-level README is not clear about repository maintenanceΒ #88

Description

@trevor-vaughan

The Issue

As a contributor to the repository, I expect the top-level README.md to have all "happy path" and warning information for basic updates.

I understand from the README and the CONTRIBUTING guide that this is a Hugo project that has a sync tool somewhere in it that I should run.

What I'm not clear on is what is controlled only by this repository and what is not. Without this information being clear (or easily discoverable) it is very difficult to determine the correct location to add/modify material.

It looks like everything that is dynamic lands in content/docs/projects and nothing outside of that is affected. That said, I'm not 100% sure based on recent PR conversations so it would be great to have things be 100% clear without needing to read through the code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    Priority

    Low

    Effort

    None yet

    Projects

    Status
    Ready πŸš€

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions