Skip to content

docs: update docs#5

Merged
codyshoffner merged 12 commits intomainfrom
chore/readme
Mar 13, 2026
Merged

docs: update docs#5
codyshoffner merged 12 commits intomainfrom
chore/readme

Conversation

@codyshoffner
Copy link
Copy Markdown
Contributor

@codyshoffner codyshoffner commented Mar 9, 2026

Description

I tried to structure these docs in the mind of this package possibly being the first UDS Package that a developer may ever see / use.

  • Updated README to better reflect the purpose of the repository.
  • Added docs on how to develop for the helm chart / go app.
  • Added docs on the uds package configuration.

Related Issue

Relates to https://github.com/orgs/uds-packages/projects/2/views/20?pane=issue&itemId=145647805&issue=uds-packages%7Cmaintenance%7C112

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@codyshoffner codyshoffner changed the title Chore/readme docs: update docs Mar 10, 2026
@codyshoffner codyshoffner marked this pull request as ready for review March 10, 2026 17:48
Comment thread docs/configuration.md Outdated
Comment thread docs/configuration.md Outdated
Comment thread docs/configuration.md Outdated
Comment thread docs/go-app.md Outdated
Comment thread docs/go-app.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
@codyshoffner codyshoffner merged commit 665a856 into main Mar 13, 2026
12 checks passed
@codyshoffner codyshoffner deleted the chore/readme branch April 3, 2026 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants