Skip to content

Commit ca8ed2a

Browse files
docs: move RELEASING.md out of the public repo
The release process is a maintainer-internal recipe — there's no external audience for the publish-RC-then-publish-real flow, the TestPyPI/PyPI configuration, or the workflow gating table. Moving the file out of the public repo prevents an external reader from mistaking it for guidance they should follow. Changes: - ``docs/RELEASING.md`` removed from this repo. The full content is now in the private ``openarmature-coord`` repo under ``docs/openarmature-python-RELEASING.md``. - ``mkdocs.yml`` ``exclude_docs: RELEASING.md`` removed — the file no longer needs an exclusion since it no longer exists here. - ``docs/contributing/index.md`` no longer links to RELEASING.md; the page becomes a stub. Past CHANGELOG entries reference ``docs/RELEASING.md`` (e.g., the 0.5.0 entry). Those are snapshot history and intentionally not edited — the references describe what was true at that release.
1 parent 54ae52a commit ca8ed2a

3 files changed

Lines changed: 3 additions & 195 deletions

File tree

docs/RELEASING.md

Lines changed: 0 additions & 184 deletions
This file was deleted.

docs/contributing/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Contributing
22

3-
Contributor-facing docs (development setup, release process, etc.)
4-
land here. For the current release process, see
5-
[`docs/RELEASING.md`](https://github.com/LunarCommand/openarmature-python/blob/main/docs/RELEASING.md)
6-
in the repo (the file is contributor-internal and intentionally not
7-
rendered as a docs page).
3+
Contributor-facing docs (development setup, repo conventions, etc.)
4+
land here. Stub for now — populated as concrete contributor-facing
5+
material accrues.

mkdocs.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ edit_uri: edit/main/docs/
1010
# on the maintainer's workstation; 8765 is the project convention.
1111
dev_addr: "127.0.0.1:8765"
1212

13-
# RELEASING.md is contributor-facing — not part of the rendered site.
14-
# (A future PR may fold it into ``contributing/`` as a proper page.)
15-
exclude_docs: |
16-
RELEASING.md
17-
18-
1913
theme:
2014
name: material
2115
palette:

0 commit comments

Comments
 (0)