generated from nhcarrigan/template
docs: document rondelle project and update nav badge
This commit is contained in:
@@ -743,7 +743,7 @@ export const navigation = [
|
||||
{
|
||||
label: "Rondelle",
|
||||
link: "/projects/rondelle",
|
||||
badge: { text: "unreleased", variant: "danger" },
|
||||
badge: { text: "unversioned", variant: "success" },
|
||||
},
|
||||
{
|
||||
label: "Chronara",
|
||||
|
||||
@@ -2,36 +2,39 @@
|
||||
title: Rondelle
|
||||
---
|
||||
|
||||
Rondelle (hereinafter the "Application") is
|
||||
Rondelle (hereinafter the "Application") is an initialized repository currently in scaffold state, created from the standard project template.
|
||||
|
||||
## 1. User Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
There is no published live application instance documented in the repository at this time.
|
||||
|
||||
This section is for those interacting with a live instance of the Application.
|
||||
Current repository status indicates foundational setup only, with end-user functionality still to be implemented.
|
||||
|
||||
## 2. Technical Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
The repository currently contains baseline governance and policy files from the project template.
|
||||
|
||||
This section is for those interested in running their own instance of the Application.
|
||||
At present:
|
||||
|
||||
1. No implementation source directories are defined.
|
||||
2. No runtime package manifest or build pipeline is configured.
|
||||
3. No environment variables or deployment instructions are published.
|
||||
|
||||
Technical documentation should be expanded once project runtime architecture is added.
|
||||
|
||||
## 3. Legal Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
Project policy files reference global documentation:
|
||||
|
||||
This section is for expansions to our legal policies specific to the Application.
|
||||
1. License: https://docs.nhcarrigan.com/#/license
|
||||
2. Terms: https://docs.nhcarrigan.com/#/terms
|
||||
3. Privacy: https://docs.nhcarrigan.com/#/privacy
|
||||
4. Security: https://docs.nhcarrigan.com/#/security
|
||||
|
||||
Copyright is held by Naomi Carrigan.
|
||||
|
||||
## 4. Contributing Documentation
|
||||
|
||||
:::note
|
||||
This section is coming soon!
|
||||
:::
|
||||
Contributions are accepted through pull requests under the repository contributing guidelines and Code of Conduct.
|
||||
|
||||
This section is for documentation related to contributing to the Application's codebase.
|
||||
Feedback and bug reports are handled via https://support.nhcarrigan.com.
|
||||
Reference in New Issue
Block a user