Add work-in-progress notices

py-mine · Aug 2, 2024 · 288dba2 · 288dba2
1 parent 5e79c26
commit 288dba2
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 1 deletion.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,15 @@
 
     Major and minor releases also include the changes specified in prior development releases.
 
-TODO: Find a way to have towncrier generate unreleased changes
+!!! bug "Missing unreleased changes"
+
+    This changelog doesn't contain any unreleased (pending) changes, even if they are present in this version of the
+    project documentation already. If you are interested in knowing what these changes are, you can take a look at the
+    [`changes/`](https://github.com/py-mine/mcproto/tree/main/changes) directory of the project.
+
+    In the future, we want to display these changes properly in this documentation, however, doing so requires running
+    a command dynamically, and showing it's output here, which we currently don't support.
+
+    <!-- TODO: Find a way to fix this. -->
 
 --8<-- "CHANGELOG.md"
diff --git a/docs/contributing/guides/changelog.md b/docs/contributing/guides/changelog.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/deprecations.md b/docs/contributing/guides/deprecations.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/great_commits.md b/docs/contributing/guides/great_commits.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/index.md b/docs/contributing/guides/index.md
@@ -1 +1,9 @@
 # Contributing guides & guidelines
+
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
+
+<!-- This include is temporary -->
+
+--8<-- "CONTRIBUTING.md"
diff --git a/docs/contributing/guides/installation.md b/docs/contributing/guides/installation.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/precommit.md b/docs/contributing/guides/precommit.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/style_guide.md b/docs/contributing/guides/style_guide.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/type_hints.md b/docs/contributing/guides/type_hints.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
diff --git a/docs/contributing/guides/unit_tests.md b/docs/contributing/guides/unit_tests.md
@@ -0,0 +1,3 @@
+!!! bug "Work In Progress"
+
+    This page is still being written. The content below (if any) may change.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		!!! bug "Work In Progress"

		This page is still being written. The content below (if any) may change.