Skip to content

Commit 9a99152

Browse files
authored
Update README.md
1 parent afff72d commit 9a99152

File tree

1 file changed

+4
-40
lines changed

1 file changed

+4
-40
lines changed

README.md

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,10 @@
1-
> [!IMPORTANT]
2-
> *Remove this section from your README.md after completing all setup tasks!*
3-
> - [ ] Click the green "Use this template" button above.
4-
> - [ ] Name your new repository and create it.
5-
> - [ ] Replace all the grey placeholder texts with your project-specific information.
6-
> - [ ] Add any additional relevant Markdown documents to your documentation.
7-
> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
8-
> - [ ] **Remove this setup section from your README.md.**
9-
>
10-
> *That's it! You are now set up, and your documentation site is live!*
1+
# OS2forms documentation readme
112

3+
This repository contains documentation for OS2forms. The documentation is build and published using Github actions and the [Just the docs](https://just-the-docs.com/) theme.
124

13-
# [Replace with Project Title]
14-
> Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
5+
To update the documentation please make a pull request to this repository.
156

16-
[How It Works](#🧭-how-it-works) | [Architecture](#architecture) | [ How to Install and Run](#▶️-how-to-install-and-run)
17-
18-
## 🧭 How It Works
19-
> Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
20-
21-
#### Architecture
22-
23-
> Replace with a Brief introduction to the project's high-level architecture. Link to the architecture documentation with a diagram preferably in mermaid syntax.
24-
[ARCHITECTURE.MD](./docs/ARCHITECTURE.MD)
25-
26-
#### Key Features
27-
28-
> Replace this with a brief explaination of the main features or functionalities of your project.
29-
30-
## ▶️ How to Install and Run
31-
> Replace with clear, concise instructions on how to install and run the codebase for development, test and production setups. Link to repositories containing deployment templates that automates deployment
32-
33-
#### Setting up a development enviroment
34-
> Describe how to get a development enviroment up and running
35-
36-
#### Deploying to production
37-
> Describe the different deployment methods for the project. Please adhere to the deployment standards recommended by OS2 when describing how to get the project running in production.
38-
39-
####
40-
41-
## :star: Examples
42-
43-
> Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
7+
Your PR should use standard markdown and follow the conventions for navigation etc. documented [here](https://just-the-docs.com/docs/navigation-structure/)
448

459
---
4610

0 commit comments

Comments
 (0)