Skip to content

Documentation cleanup - #298

Merged
xtrinch merged 9 commits into
masterfrom
chore/fix-status-v1-migration-docs
Apr 3, 2026
Merged

Documentation cleanup#298
xtrinch merged 9 commits into
masterfrom
chore/fix-status-v1-migration-docs

Conversation

@xtrinch

@xtrinch xtrinch commented Apr 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • move the legacy pre-1.0 migration notes out of the main README into a standalone docs page under docs/pages/
  • move the custom FCMDevice model guide into its own standalone docs page and add a visible docs section for extracted pages
  • fix stale README/docs content, including Python and Django compatibility notes, topic subscription examples, the multi-app example, DRF permissions wording, and section ordering

Why

The main README had accumulated legacy upgrade notes, advanced customization guidance, and a few stale examples that made the landing page harder to scan and, in some places, inaccurate. Pulling long-tail content into standalone pages keeps the main docs focused on current usage while preserving older migration and customization guidance.

Impact

Current users get a cleaner README and docs index, while advanced or legacy topics remain discoverable through dedicated pages. The docs also now better match the actual supported Python/Django versions and current API usage.

Validation

  • python3 -m compileall fcm_django

@xtrinch xtrinch changed the title Move legacy v1 migration notes out of the README Documentation cleanup Apr 3, 2026
@xtrinch
xtrinch marked this pull request as ready for review April 3, 2026 11:20
@xtrinch
xtrinch merged commit 3565c82 into master Apr 3, 2026
6 checks passed
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.

1 participant