Doc updates

[coordt]

Updates the documentation

[github-actions]

Version hint: patch
Current version: 0.17.2
New version (when merged): 0.17.3

_{Comment ID: Display the version hint-auto-generated}

[codecov]

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (c15b23b) 93.22% compared to head (135a86f) 93.40%.
Report is 22 commits behind head on master.

Files	Patch %	Lines
bumpversion/scm.py	14.28%	4 Missing and 2 partials ⚠️
bumpversion/versioning/models.py	95.68%	2 Missing and 3 partials ⚠️
bumpversion/config/models.py	50.00%	3 Missing ⚠️
bumpversion/version_part.py	90.90%	0 Missing and 1 partial ⚠️
bumpversion/versioning/conventions.py	90.90%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #134      +/-   ##
==========================================
+ Coverage   93.22%   93.40%   +0.17%     
==========================================
  Files          21       24       +3     
  Lines        1403     1486      +83     
  Branches      292      297       +5     
==========================================
+ Hits         1308     1388      +80     
- Misses         66       68       +2     
- Partials       29       30       +1     

Flag	Coverage Δ
python-3.10	93.40% <93.36%> (+0.17%)	⬆️
python-3.11	93.40% <93.36%> (+0.17%)	⬆️
python-3.8	93.40% <93.36%> (+0.17%)	⬆️
python-3.9	93.40% <93.36%> (+0.17%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.