diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index 3f38980..2ce77f8 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -104,6 +104,25 @@ Example page with this Work in Progress admonition: [:octicons-arrow-right-16: E Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. ``` + +#### Placeholder Page +For pages that are newly created and have no (or very little) content on the page itself. Also used for `index.md` pages in directories that have other contents, but no content on the directory index. + +Example page with the Placeholder Page admonition: [:octicons-arrow-right-16: Example Placeholder Page Admonition](example_pages/example_placeholder_page_admonition.md) + +??? quote "Syntax" + Copy and paste at the bottom of page content: + ``` + !!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + ``` + +!!! tip + Typically, any page that is marked as a Placeholder Page should also be marked with the **Work in Progress** admonition because they are, by their nature, incomplete. + + Example page with the Placeholder and WIP admonitions: [:octicons-arrow-right-16: Example Placeholder and WIP Admonitions](example_pages/example_wip_placeholder_admonitions.md) + Source code that you can quickly copy from when making an index or placeholder page is located [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). + --- !!! example "Work in Progress" diff --git a/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md new file mode 100644 index 0000000..5e01f88 --- /dev/null +++ b/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md @@ -0,0 +1,11 @@ +# Example page: Placeholder Page admonition + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +There might be a little bit of content here, but nothing substantial. + +This is an example page to show the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_placeholder_page_admonition.md). + +--- +Typically, you would also place a [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) on this page, as it is incomplete. For an example of a full Placeholder and WIP page, see [text](example_wip_placeholder_admonitions.md) \ No newline at end of file diff --git a/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md new file mode 100644 index 0000000..9551956 --- /dev/null +++ b/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md @@ -0,0 +1,12 @@ +# Example page: Placeholder Page and WIP admonitions + +!!! abstract "Placeholder Page" + This is a placeholder page. Please see the site navigation for any sub-pages that exist. + +This is an example page to show both the [:octicons-arrow-right-16: Placeholder Page admonition](../editing.md#placeholder-page) and the [:octicons-arrow-right-16: Work in Progress admonition](../editing.md#work-in-progress) (scroll down to the bottom!). You can see the source code for this page [:simple-forgejo: here](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/handbook/meta/example_pages/example_wip_placeholder_admonitions.md). + +--- +!!! example "Work in Progress" + This page is not complete, and is subject to change. + + Want to help with this page? Please see [:octicons-arrow-right-16: Editing this site](https://about.starcat.systems/editing/) and the [:simple-forgejo: Git repo](https://git.starcat.systems/starcatsys/about_docs) for this site. \ No newline at end of file