Skip to content

docs: Filling in remaining docs#57

Merged
timmc-edx merged 3 commits intomainfrom
timmc/finish-docs
May 21, 2025
Merged

docs: Filling in remaining docs#57
timmc-edx merged 3 commits intomainfrom
timmc/finish-docs

Conversation

@timmc-edx
Copy link
Contributor

  • Add docs for monitoring and migration
  • Add ADRs for repo purpose, lack of a DB, and lack of auth
  • Update badges: Remove pyversions (it's not on PyPI), fix CI badge (I don't know why the branch param was breaking it), update the status, fix alt text
  • Combine debugging page and special dev notes in README into new page on development, along with a new Setup section
  • In README, point people to the docs dir until RTD is set up
  • Reorder TOC

Merge checklist:
Check off if complete or not applicable:

  • Changelog record added
  • Documentation updated (not only docstrings)
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@timmc-edx timmc-edx mentioned this pull request May 15, 2025
6 tasks
- Add docs for monitoring and migration
- Add ADRs for repo purpose, lack of a DB, and lack of auth
- Update badges: Remove pyversions (it's not on PyPI), fix CI badge (I
  don't know why the branch param was breaking it), update the status, fix
  alt text
- Combine debugging page and special dev notes in README into new page on
  development, along with a new Setup section
- In README, point people to the docs dir until RTD is set up
- Reorder TOC
@timmc-edx timmc-edx force-pushed the timmc/finish-docs branch from 0b80c9d to 8733257 Compare May 19, 2025 18:10
@timmc-edx timmc-edx moved this to In Review in Arch-BOM May 19, 2025
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, it may make sense to backport docs, and that hopefully wouldn't be an issue for BTR. We should ask.

timmc-edx and others added 2 commits May 21, 2025 12:40
@timmc-edx
Copy link
Contributor Author

On the topic of backporting, I don't think this repo has even been tagged for Teak. I'll check in about that.

@timmc-edx timmc-edx merged commit 8499956 into main May 21, 2025
7 checks passed
@timmc-edx timmc-edx deleted the timmc/finish-docs branch May 21, 2025 18:19
@github-project-automation github-project-automation bot moved this from In Review to Done in Arch-BOM May 21, 2025
@jristau1984 jristau1984 moved this from Done to Done - Long Term Storage in Arch-BOM Jul 31, 2025
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