Skip to content

docs: Improve consistency #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Key features
that updating frameworks in the future doesn't necessitate rebuilding your
site's plugin structure. ​

* **Pre-Integrated Bootstrap 5 Components**: Access a ready-to-use collection
* **Built-in Bootstrap 5 Components**: Access a ready-to-use collection
of Bootstrap 5 components, streamlining the process of building responsive
and modern interfaces. ​

Expand Down
12 changes: 6 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@ and templates.
* **Effortless Development of Custom Frontend Components**: Create reusable frontend
components with ease, utilizing simple templates and declarative form
classes. These components can function both as CMS plugins and within
standard Django templates.
standard Django templates.

* **Framework-Agnostic Design**: Maintain flexibility in your project's design
by decoupling plugins from specific versions of a CSS framework. This ensures
that updating frameworks in the future doesn't necessitate rebuilding your
site's plugin structure.
site's plugin structure.

* **Pre-Integrated Bootstrap 5 Components**: Access a ready-to-use collection
* **Built-in Bootstrap 5 Components**: Access a ready-to-use collection
of Bootstrap 5 components, streamlining the process of building responsive
and modern interfaces.
and modern interfaces.

* **Extensibility**: Enhance your project by creating custom frontend components with
minimal code. The system is designed to be extended both within individual
projects and through separate theme applications.
projects and through separate theme applications.

* **Consistent User Experience**: Utilize plugins as UI components throughout
your project, promoting a cohesive and uniform user interface.
your project, promoting a cohesive and uniform user interface.

*************
Description
Expand Down
2 changes: 1 addition & 1 deletion docs/source/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Built-in Components
#####################

Find the available pre-built components for Boostrap 5 in the following sections:
Find the available built-in components for Boostrap 5 in the following sections:

.. toctree::
:maxdepth: 1
Expand Down
7 changes: 4 additions & 3 deletions docs/source/tutorial/builtin_components.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
.. _built_in_components:

######################################
Using Pre-Built Bootstrap 5 Components
Using Built-In Bootstrap 5 Components
######################################

.. index::
single: Pre-Built Components
single: Built-In Components
single: Bootstrap 5 Components


Here's a step-by-step tutorial to get you started with ``djangocms-frontend``, a versatile plugin bundle
for django CMS that provides a suite of frontend components compatible with various CSS frameworks, including Bootstrap 5.

For this tutorial we will be using the pre-built Boostrap 5 components that come with ``djangocms-frontend``.
For this tutorial we will be using the built-in Boostrap 5 components that come with ``djangocms-frontend``.

Installation
============
Expand Down
6 changes: 3 additions & 3 deletions docs/source/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
#################

When working with components in ``djangocms-frontend``, you can choose from different
approaches depending on your needs. These range from using pre-built Bootstrap 5
approaches depending on your needs. These range from using built-in Bootstrap 5
components, over quick and simple methods to create your own custom frontend components to
more flexible but complex solutions. We recommend staying with the simplest approach
that gets the job done for your project.

1. **Pre-Built Bootstrap 5 Components** – The easiest way to **get started** with
``djangocms-frontend``. Pre-built components are ready to use and require no additional
1. **Built-in Bootstrap 5 Components** – The easiest way to **get started** with
``djangocms-frontend``. Built-in components are ready to use and require no additional
configuration. They are perfect for quickly setting up a website with a variety of components
that are compatible with Bootstrap 5. Pre-built components need to be explicitly
added to your project's ``INSTALLED_APPS``.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tutorial/template_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ If you do not use the built-in components, you do not need to add them to your `
'djangocms_icon',
'easy_thumbnails',
'djangocms_link', # Required if djangocms_frontend.contrib.link is used
# Main frontend app - pre-built components not needed
# Main frontend app - built-in components from contrib not needed
'djangocms_frontend',
]

Expand Down