Skip to content

Move explainers to their own subdirectory#98

Merged
MrPickles merged 5 commits intoprivacycg:mainfrom
MrPickles:explainer-subdirectory
Mar 13, 2025
Merged

Move explainers to their own subdirectory#98
MrPickles merged 5 commits intoprivacycg:mainfrom
MrPickles:explainer-subdirectory

Conversation

@MrPickles
Copy link
Copy Markdown
Collaborator

@MrPickles MrPickles commented Mar 3, 2025

Since there are additional explainers expected to be published around bounce tracking mitigations, this PR creates an explainers/ directory to hold all relevant explainers. Additionally, it puts the explainer for stateless BTM from #41 in the repository.

The original BTM explainer at the top level is turned into a symlink to avoid creating a dead link. (However, I'm open to suggestions around this. Maybe it's better to just move the file without keeping a symlink and retroactively fix any incoming links from ChromeStatus or TAG reviews.)


Preview | Diff

@MrPickles MrPickles marked this pull request as ready for review March 4, 2025 15:09
@MrPickles
Copy link
Copy Markdown
Collaborator Author

@svendlarsen PTAL and let me know your thoughts, especially since this affects where you might publish an explainer

@svendlarsen
Copy link
Copy Markdown
Contributor

I think an explainers directory makes sense. I think having the stateless BTM explainer here is also good — definitely improves discoverability vs. the current state of only having it in the comments of an issue.

A symlink seems fine to me, though I'm still pretty new to spec/CG work so I'm not sure if symlinks are discouraged for some reason. If this PR changes to not symlink, then the link to the explainer from the spec should also be changed.

@MrPickles MrPickles merged commit 15a4abf into privacycg:main Mar 13, 2025
1 check passed
@MrPickles MrPickles deleted the explainer-subdirectory branch March 13, 2025 17:37
github-actions bot added a commit that referenced this pull request Mar 13, 2025
SHA: 15a4abf
Reason: push, by MrPickles

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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