Skip to content

Commit af923bf

Browse files
authored
docs: Improve consistency (#265)
1 parent ebedc46 commit af923bf

File tree

6 files changed

+16
-15
lines changed

6 files changed

+16
-15
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Key features
2626
that updating frameworks in the future doesn't necessitate rebuilding your
2727
site's plugin structure. ​
2828

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

docs/source/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,23 @@ and templates.
2323
* **Effortless Development of Custom Frontend Components**: Create reusable frontend
2424
components with ease, utilizing simple templates and declarative form
2525
classes. These components can function both as CMS plugins and within
26-
standard Django templates.
26+
standard Django templates.
2727

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

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

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

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

4444
*************
4545
Description

docs/source/plugins/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Built-in Components
66
#####################
77

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

1010
.. toctree::
1111
:maxdepth: 1

docs/source/tutorial/builtin_components.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
.. _built_in_components:
22

33
######################################
4-
Using Pre-Built Bootstrap 5 Components
4+
Using Built-In Bootstrap 5 Components
55
######################################
66

77
.. index::
8-
single: Pre-Built Components
8+
single: Built-In Components
9+
single: Bootstrap 5 Components
910

1011

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

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

1617
Installation
1718
============

docs/source/tutorial/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
#################
77

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

14-
1. **Pre-Built Bootstrap 5 Components** – The easiest way to **get started** with
15-
``djangocms-frontend``. Pre-built components are ready to use and require no additional
14+
1. **Built-in Bootstrap 5 Components** – The easiest way to **get started** with
15+
``djangocms-frontend``. Built-in components are ready to use and require no additional
1616
configuration. They are perfect for quickly setting up a website with a variety of components
1717
that are compatible with Bootstrap 5. Pre-built components need to be explicitly
1818
added to your project's ``INSTALLED_APPS``.

docs/source/tutorial/template_components.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you do not use the built-in components, you do not need to add them to your `
3838
'djangocms_icon',
3939
'easy_thumbnails',
4040
'djangocms_link', # Required if djangocms_frontend.contrib.link is used
41-
# Main frontend app - pre-built components not needed
41+
# Main frontend app - built-in components from contrib not needed
4242
'djangocms_frontend',
4343
]
4444

0 commit comments

Comments
 (0)