Skip to content

Commit f10e39d

Browse files
docs: follow rst standard for subtitles
1 parent 6152dba commit f10e39d

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

docs/decisions/0017-generalized-containers.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Context
77
This ADR proposes a model for containers that can hold different types of content and can be used to model other content types with similar behavior, such as units, subsections, sections, or courses. The model defines containers' core structure and purpose, the types of containers, content constraints, container children, version control, publishing, and pruning.
88

99
Key Concepts
10-
============
10+
~~~~~~~~~~~~~
1111

1212
The following definitions provide context for the terms used in this ADR:
1313

@@ -24,7 +24,7 @@ Decisions
2424
---------
2525

2626
1. Core Structure and Purpose of Containers
27-
===========================================
27+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2828

2929
This section defines the purpose and structure of containers, explaining how they are designed to hold various types of content through a parent-child setup.
3030

@@ -37,7 +37,7 @@ This section defines the purpose and structure of containers, explaining how the
3737
- Units (units Django application, builds on containers and selectors).
3838

3939
2. Container Types and Content Constraints
40-
==========================================
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4141

4242
This section defines container types, content constraints, hierarchy, and extensibility. It introduces the main types of containers and outlines how content limitations and configurations are handled at the application level to support flexible content structures.
4343

@@ -49,7 +49,7 @@ This section defines container types, content constraints, hierarchy, and extens
4949
- Containers will follow extensibility principles in `Content Extensibility Through Model Relations <0003-content-extensibility.rst>`_ for creating new container types or subtypes.
5050

5151
3. Container Children and Relationships
52-
=======================================
52+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5353

5454
This section defines container children, their order, and relationships, covering flexible connections and support for draft and published states of their children.
5555

@@ -63,7 +63,7 @@ This section defines container children, their order, and relationships, coverin
6363
- A single child (publishable entity) can be shared by multiple containers, allowing for reuse of content across different containers. For instance, a component can be shared by multiple units.
6464

6565
4. Container Versioning, Deletions and Structural Changes
66-
==============================================================
66+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6767

6868
This section defines the versioning rules for containers, explaining when a new version is created based on structural or metadata changes. It also clarifies how changes in child elements affect (or do not affect) container versions.
6969

@@ -74,7 +74,7 @@ This section defines the versioning rules for containers, explaining when a new
7474
- Changes to container metadata, such as updating its title or description, will also create a new version.
7575

7676
5. Publishing
77-
=============
77+
~~~~~~~~~~~~~
7878

7979
This section explains the publishing process for containers, detailing how containers and their children become accessible, either together or independently, based on their publication state. The publishing process happens on container versions, but throughout this section we'd call them containers for simplicity.
8080

@@ -84,7 +84,7 @@ This section explains the publishing process for containers, detailing how conta
8484
- Containers are not affected by the publishing process of its children. This means that publishing a component won't trigger new publishing processes for a container.
8585

8686
6. Pruning
87-
==========
87+
~~~~~~~~~~
8888

8989
This section defines the rules for pruning container versions, explaining when a container version can be pruned and the effects of pruning on the container and its children.
9090

docs/decisions/0018-units-as-containers.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ Decisions
1212
All decisions from `0017-generalized-containers.rst <0017-generalized-containers.rst>`_ are still valid but are written here alongside unit-specific decisions for better illustration.
1313

1414
1. Units as Containers
15-
=======================
15+
~~~~~~~~~~~~~~~~~~~~~~~
1616

1717
- A unit is a concrete type of container that holds components.
1818
- A unit is a container, making it also a publishable entity.
1919
- Units build on the generalized container capability to hold components and selectors for dynamically selecting 0-N PublishableEntities.
2020
- Units have their own Django application that builds on containers and selectors.
2121

2222
2. Unit Types and Content Constraints
23-
======================================
23+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2424

2525
- Units can only hold components as their children but will not enforce this restriction at the model level.
2626
- Units are the first level of nested content types Unit > Components.
2727
- Content restrictions for units are implemented at the application layer, allowing units to limit their children to only components. None of this is enforced at the model level.
2828
- Unit subtypes can be created by following the extensibility principles in `Content Extensibility Through Model Relations <0003-content-extensibility.rst>`_.
2929

3030
3. Unit Children and Relationships
31-
==================================
31+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3232

3333
- The children of a unit can only be components.
3434
- Components in a unit are referenced as an ordered list. For example, a unit can have a list of components that are ordered by the author.
@@ -37,20 +37,20 @@ All decisions from `0017-generalized-containers.rst <0017-generalized-containers
3737
- A single component can be reference by multiple units.
3838

3939
4. Next Unit Versions
40-
======================
40+
~~~~~~~~~~~~~~~~~~~~~
4141

4242
Only changes to the unit itself (e.g., title, ordering of components, adding or removing a component, or changes to the unit's metadata) will create a new version of the unit. Changes to the components of a unit will not create a new version of the unit.
4343

4444
5. Publishing
45-
==============
45+
~~~~~~~~~~~~~
4646

4747
- Units can be published, allowing their content to be accessible from where the unit is being used. Only after a unit is published it can be reused as content for other containers.
4848
- When a draft unit is published, all its draft components are also published.
4949
- Components within a unit can be published independently of the unit itself. This could happen for components that are shared by multiple units.
5050
- Units are not affected by the publishing process of its components.
5151

5252
6. Pruning
53-
==========
53+
~~~~~~~~~~
5454

5555
- A unit version can be pruned if it's not being used by any subsections, it's not a published version, and it's not the latest version of the unit.
5656
- In a top-down approach, start with the unit and work your way down to its component versions.

docs/decisions/0019-selectors.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
19. Selectors for Dynamically Selecting Content
2-
===========================================
2+
===============================================
33

44
Context
55
-------
@@ -12,7 +12,7 @@ This ADR proposes a way to represent dynamic members of a container, where dynam
1212
And any other custom use case to dynamically select members for a container. This proposal introduces the concepts of selectors and variants to implement this type of dynamic selection.
1313

1414
1. Core Structure
15-
=================
15+
~~~~~~~~~~~~~~~~~
1616

1717
This section explains the concepts and behaviors used to build dynamic selection, selectors and variants.
1818

@@ -23,7 +23,7 @@ This section explains the concepts and behaviors used to build dynamic selection
2323
- Variants are build on the parent-child relationship used for containers and their members, storing the dynamically selected content as an ordered list as containers do.
2424

2525
2. Selector Types and Selecting Content
26-
=======================================
26+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2727

2828
This section describes how different types of selectors work and how they handle the selection of dynamic content.
2929

@@ -33,7 +33,7 @@ This section describes how different types of selectors work and how they handle
3333
- A compositor is responsible for populating the variants but will not be implemented as part of the selector application which belongs to the authoring app.
3434

3535
3. Versioning
36-
=============
36+
~~~~~~~~~~~~~
3737

3838
A new version of a selector is created whenever the pool of concent changes by adding, removing or reordering existing members.
3939

0 commit comments

Comments
 (0)