Skip to content

Commit 1ddffe4

Browse files
committed
Add WIP flag
1 parent 58ec578 commit 1ddffe4

4 files changed

Lines changed: 9 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ Each documentation page has YAML frontmatter at the top with metadata. Common fi
112112
- `title`: The page title displayed in the header and navigation
113113
- `description`: A short description of the page content (direct field, not nested under `metadata`)
114114
- `obsolete`: (boolean) Whether the page contains obsolete documentation, usually from a previous version, that requires updating
115+
- `wip`: (boolean) Whether the page is a work in progress and not yet complete. Compared to "obsolete", this indicates the page is valid for the current version, but is actively being worked on.
115116
- `tags`: (array) Optional tags displayed to the user for categorization
116117
- `keywords`: (array) Optional keywords for search optimization
117118

app/templates/pages/chapter.html.twig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
{% block page_content %}
77
<div class="chapter-content">
8+
{% include "partials/wip.html.twig" %}
89
{% include "partials/obsolete.html.twig" %}
910
{{ page.getContent()|raw }}
1011
</div>

app/templates/pages/docs.html.twig

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
<div class="docs-content">
88
<h1>{{ page.getTitle() }}</h1>
99
{% include "partials/tags.html.twig" %}
10+
{% include "partials/wip.html.twig" %}
1011
{% include "partials/obsolete.html.twig" %}
1112
{{ page.getContent()|raw }}
1213
</div>
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{% if page.getFrontMatter().wip %}
2+
<div class="uk-alert uk-alert-warning">
3+
<p class="uk-alert-title"><i class="fa-solid fa-clock uk-icon"></i>Work in progress</p>
4+
<p>This page is a work in progress. Help complete it by <a href="{{ page.github }}">contributing on GitHub</a>!</p>
5+
</div>
6+
{% endif %}

0 commit comments

Comments
 (0)