docs: align all documentation with current code and deploy topology - #95
Merged
Conversation
The repo moved from the checkmarkdevtools org to anchildress1 and the deploy model flipped: Firebase Hosting is now the primary (upstream) target with gh-pages as the fork fallback. The docs still described the old org, the old gh-pages-primary model, and entry points that no longer exist. README: rewrite for new-dev onboarding — correct live site (crawly.anchildress1.dev), fix every badge org path + add Firebase Hosting badge, add Tech Stack, a validated Mermaid architecture diagram, Project Structure, and a Configuration table (fork vs upstream vars incl. FIREBASE_WEB_CONFIG). Correct the inverted deploy topology and the fork setup workflow. DEV_GUIDE/CI_GUIDE: replace nonexistent scripts/generate_site.py and render_index_sitemap.py with the real module entry points (devto_mirror.site_generation.generator/renderer), fix the package tree (src/devto_mirror/), the fork setup workflow name, and stale domains. SECURITY.md/LICENSE/llms.txt: scrub the old checkmarkdevtools brand and contact email to anchildress1@gmail.com. MIGRATION_PLAN: add a superseded banner (historical artifact, body kept). Generated-by: Claude Opus 4.8 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Ashley Childress <anchildress1@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s active documentation and contact/branding references to reflect the current repo location (anchildress1) and the deploy topology (Firebase Hosting upstream, GitHub Pages for forks), replacing stale org links, workflow names, and nonexistent script entrypoints.
Changes:
- Rewrite/expand README with updated live-site link, badges, architecture description/diagram, setup steps, and configuration tables for fork vs upstream deploy paths.
- Update DEV/CI guides to reference the real module entry points (
python -m devto_mirror.site_generation.{generator,renderer}) and current repo structure/workflow names. - Scrub old brand/contact info in SECURITY.md, LICENSE, and assets/llms.txt.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| SECURITY.md | Updates security-contact narrative and email/address references to current ownership. |
| README.md | Major doc refresh: new live-site link, badges, architecture + setup/config guidance aligned to Firebase-upstream / Pages-fork model. |
| LICENSE | Updates licensing contact email to current address. |
| docs/MIGRATION_PLAN.md | Adds “historical artifact” banner clarifying the plan is superseded and pointing to current structure. |
| docs/DEV_GUIDE.md | Replaces nonexistent script commands with real module entry points; updates domain/examples and workflow name references. |
| docs/CI_GUIDE.md | Updates pipeline description to reflect renderer module usage and clarifies permissions/state-branch behavior. |
| assets/llms.txt | Updates contact and copyright holder references. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 093bce63d4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…back The GitHub Actions Setup section jumped straight into GitHub Pages with no mention that the upstream/primary deploy is now Firebase Hosting. Add a two-path intro so the gh-pages-to-Firebase swap is reflected here too. Generated-by: Claude Opus 4.8 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Ashley Childress <anchildress1@gmail.com>
…label - Architecture: state lives on a separate branch upstream (mirror-state) but alongside the site on gh-pages for forks; the blanket 'separate branch' claim was wrong for forks (Copilot) - Restore the 'delete inherited gh-pages' step in both the README Quick Setup and DEV_GUIDE fork setup — forks inherit upstream's gh-pages with its state, so the first run skipped posts and republished stale content (Codex P2) - Quote the Mermaid artifacts label so posts_data.json no longer reads as a trailing-slash directory path (Copilot) Generated-by: Claude Opus 4.8 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Ashley Childress <anchildress1@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why 📚
The repo moved (
checkmarkdevtoolsorg →anchildress1) and the deploy model flipped — Firebase Hosting is now primary (upstream), with gh-pages as the fork fallback. The docs still described the old org, the old gh-pages-primary model, and entry-point scripts that no longer exist. This aligns every active doc with what the code actually does.README (rewrite, new-dev friendly) 🔧
crawly.anchildress1.dev; banner uses a relative path (survives transfers)checkmarkdevtools→anchildress1); added a Firebase Hosting badge — no badges lostFIREBASE_WEB_CONFIG)Guides
scripts/generate_site.pyandrender_index_sitemap.pywith the real module entry points (devto_mirror.site_generation.generator/renderer); fixed the package tree (src/devto_mirror/), the fork setup workflow name, stale domains, and a permissions commentBrand/contact scrub
checkmarkdevtoolsbrand +human@checkmarkdevtools.dev→anchildress1@gmail.comLeft intentionally untouched
CHANGELOG.md, dateddocs/implementations/*,COMPLEXITY_REFACTORING.md,ENV_FIXES.md— historical artifactscrawly.checkmarkdevtools.dev— stable mock datasonar-project.properties,.vscode/settings.json— repo config (not docs; out of scope)Verified ✅
make ai-checksgreen (docs-only; coverage 88.74%)valid: true)checkmarkdevtoolsrefs in active docs🤖 Generated with Claude Code