Skip to content

Conversation

@va-lang
Copy link

@va-lang va-lang commented Nov 29, 2025

Issue fix docs

Summary by Sourcery

Documentation:

  • Update the extend-frontend-plugins guide to fix an inconsistency in the documented behavior or instructions.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 29, 2025

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@va-lang
Copy link
Author

va-lang commented Nov 29, 2025

@fsbraun

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@fsbraun fsbraun changed the title docs-328:Inconsistency in Documentation docs: Fix inconsistency in Documentation Nov 29, 2025
@codecov
Copy link

codecov bot commented Nov 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.00%. Comparing base (b4575df) to head (306c218).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #329   +/-   ##
=======================================
  Coverage   89.00%   89.00%           
=======================================
  Files         124      124           
  Lines        3383     3383           
  Branches      287      287           
=======================================
  Hits         3011     3011           
  Misses        256      256           
  Partials      116      116           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Updated formatting and wording for clarity in the documentation on extending frontend plugins.
``DJANGOCMS_FRONTEND_THEME`` and defaults to ``djangocms_frontend``.
``DJANGOCMS_FRONTEND_THEME`` and defaults to ``theme``.
For a theme app called ``theme`` and the bootstrap5 framework this
would be ``theme.frontends.bootstrap5.py``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, in the below example the module is `theme.frameworks.bootstrap5.py. So does this line need updating as well?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it does!

===============
Working example: Extending the ``GridContainerPlugin``
======================================================

Copy link
Contributor

Choose a reason for hiding this comment

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

Right after the first paragraph where you're instructed to create the theme app, I would add a new (or a note) saying something along the lines of:

Make sure you make the necessary changes in your settings.py file: your theme app should be added to the list of INSTALLED_APPS, plus pointed to by the DJANGOCMS_FRONTEND_THEME setting:

INSTALLED_APPS = [
   ...,
   'theme',
   ...
]
DJANGOCMS_FRONTEND_THEME ="theme"```

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.

Inconsistency in Documentation

3 participants