canonical / canonical/github-profiles-automator

Update the README once we have public docs

Open
#15 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
1
Forks
2
Avg merge
1d 11h
Merged PRs (30d)
4

Description

### Context

Right now the README looks a bit more stale. We should enrich it in the future with more links to upstream docs, once we have them and/or more sections so that users can have a better first experience and be able to:
1. Understand what the repo is about
2. How they can get started
3. What the charm is doing

### What needs to get done

1. Evaluate a small plan on what sections to include in the README
1. I.e. should we include links to our specs?
2. What other standard sections should our READMEs have?
3. Link with upstream docs to point users to more details on how to use the charm

### Definition of Done

1. The README has more context on what the charm repo is, and how users can use it

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.