Skip to content

archive: unpublished content/archive/ for retired proposals; retire dimensions-as-types - #38

Open
egparedes wants to merge 2 commits into
mainfrom
archive-retired-proposals
Open

egparedes wants to merge 2 commits into
mainfrom
archive-retired-proposals

Conversation

@egparedes

@egparedes egparedes commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

What

Adds a minimal way to retire proposals so they stay in the repo but disappear from the published site. As the first use, it retires shared/dimensions-as-types, which is superseded by personal/egparedes/connectivities-as-types.

Changes

  • quartz.config.ts: adds archive to ignorePatterns. This is the same mechanism that already keeps templates/ and private/ off the site.
  • content/archive/: a new flat directory for retired proposals. dimensions-as-types.md moves here with git mv, so its history is kept. Its frontmatter is now status: retired plus superseded_by: personal/egparedes/connectivities-as-types/connectivities-as-types.
  • content/index.md: removes the entry from Shared. An Archived HTML comment at the bottom lists it instead, with the same keywords. Quartz doesn't render the comment, but agents and people reading the source when cross-checking new ideas still find it.
  • Inbound links: the 9 [[shared/dimensions-as-types|…]] wikilinks in published pages become plain GitHub links to the archived file. Without this they would be dead links on the site.
    • egparedes: connectivities-as-types.md (3) and …_dependent-typing.md (1)
    • havogt: dimension-generic-fields.md (5), plus one path in a code comment in typed_dimensions.py. Link targets only; the text is unchanged.
  • AGENTS.md / README.md: add archive/ to the layout, add retired to the status values, and add a new "Retiring a proposal" section that lists the steps.

Notes for review

  • This removes a file from shared/, so it needs PR review per the repo rules.
  • @havogt: please check the link edits in your files.
  • This PR leaves the existing rule "after a proposal is implemented and merged to GT4Py, delete the file" unchanged. We could later switch that rule to archiving too.
  • PR personal/egparedes: connectivities as types — Cartesian axis dimensions, and UGRID/SGRID alignment #36 also edits connectivities-as-types.md. If it merges first, any new [[shared/dimensions-as-types]] links it adds will need the same rewrite.
  • I didn't run a local Quartz build. Please check the deploy preview: there should be no archive/ pages, and the GitHub links should resolve once this is merged to main.

Add content/archive/ for retired (superseded or abandoned) proposals: kept in
git, excluded from the Quartz site via ignorePatterns. Document the retirement
procedure in AGENTS.md and the new `retired` status.

Retire shared/dimensions-as-types (superseded by connectivities-as-types):
move it to archive/, drop its index entry (listed in an unrendered Archived
comment instead), and turn inbound wikilinks into GitHub links so the
published pages have no dead links.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The archive is described as flat despite the documented workflow preserving multi-file proposals as subdirectories.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Introduces an unpublished archive for retired proposals and retires the superseded “Dimensions as types” proposal.

Changes:

  • Adds archive configuration and contributor guidance.
  • Moves the retired proposal and updates the index.
  • Replaces published inbound wikilinks with GitHub links.
File Description
AGENTS.md Documents archive and retirement workflow.
README.md Adds archive structure and retired status.
quartz.config.ts Excludes archive content from publication.
content/​archive/​dimensions-as-types.md Archives the superseded proposal.
content/​index.md Moves the proposal into the archived source listing.
content/​personal/​egparedes/​connectivities-as-types/​connectivities-as-types.md Updates three inbound links.
content/​personal/​egparedes/​connectivities-as-types/​connectivities-as-types_dependent-typing.md Updates one inbound link.
content/​personal/​havogt/​dimension-generic-fields/​dimension-generic-fields.md Updates five inbound links.
content/​personal/​havogt/​dimension-generic-fields/​typed_dimensions.py Updates the archived proposal reference.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread AGENTS.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

Only minor documentation/configuration nits remain; no blocking issues were identified.

Review effort: Lite
Findings: None

Resolved since last review (1)

@egparedes
egparedes requested a review from havogt October 2, 2026 06:30

This branch has not been deployed

No deployments
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