Infrastructure/website-docs
1
0
Fork 0
Code Issues Pull requests Activity

Initial commit

Browse source
This commit is contained in:
JeremyStar™ 2024-03-02 18:26:21 +01:00
commit 090abdf993
25 changed files with 15666 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
.gitignore vendored Normal file
View file

@ -0,0 +1,15 @@
/node_modules
/out
.docusaurus
.cache-loader
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
pnpm-lock.yaml
npm-debug.log*
yarn-debug.log*
yarn-error.log*

437
LICENSE Normal file
View file

@ -0,0 +1,437 @@
Attribution-NonCommercial-ShareAlike 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
Public License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-NonCommercial-ShareAlike 4.0 International Public License
("Public License"). To the extent this Public License may be
interpreted as a contract, You are granted the Licensed Rights in
consideration of Your acceptance of these terms and conditions, and the
Licensor grants You such rights in consideration of benefits the
Licensor receives from making the Licensed Material available under
these terms and conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. BY-NC-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution, NonCommercial, and ShareAlike.
h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
k. NonCommercial means not primarily intended for or directed towards
commercial advantage or monetary compensation. For purposes of
this Public License, the exchange of the Licensed Material for
other material subject to Copyright and Similar Rights by digital
file-sharing or similar means is NonCommercial provided there is
no payment of monetary compensation in connection with the
exchange.
l. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
m. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
n. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part, for NonCommercial purposes only; and
b. produce, reproduce, and Share Adapted Material for
NonCommercial purposes only.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties, including when
the Licensed Material is used other than for NonCommercial
purposes.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
b. ShareAlike.
In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.
1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-NC-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database for NonCommercial purposes
only;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.

24
Makefile Normal file
View file

@ -0,0 +1,24 @@
.PHONY: dist help
dist: help
help:
@echo "make install-deps -> Install all dependencies"
@echo " test -> Start a web server for development"
@echo " build -> Build static files"
@echo " clean -> Clean directory"
@echo " clean-extra -> Clean directory with extra directories/files"
install-deps:
pnpm install
test:
pnpm run start --hot-only --no-open
build:
pnpm run build --out-dir out
clean:
pnpm run clear
rm -rf "out" ".docusaurus" ".cache-loader"
clean-extra: clean
rm -rf "node_modules" "pnpm-lock.yaml"
# The nuclear option. Why is it here you might ask? I made it while creating the documentation README.md
clean-ultra: clean clean-extra
rm -rf "~/.cache/pnpm" "~/.local/share/pnpm" "~/.local/state/pnpm"

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# sos!docs
Here you can find the StarOpenSource documentation. [Click here to visit the built documentation.](https://docs.staropensource.de)
# Commands
We use [make](https://www.gnu.org/software/make/).
## Installing dependencies
```plain
$ make install-deps
```
## Development web server
This will start [a development server](http://localhost:3000) that supports hot reloading.
```plain
$ make test
```
## Building the documentation
This will output the built documentation to `out/`. Simply point a web server to it and you're done.
```plain
$ make build
```
## Cleaning the directory
This will remove the `out/` directory containing the built website aswell as Docusaurus files.
```plain
$ make clean
```
### More cleaning
This will remove the `node_modules/` and `pnpm-lock.yaml` directory aswell.
```plain
$ make clean-extra
```

3
babel.config.js Normal file
View file

@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};

12
docs/about.md Normal file
View file

@ -0,0 +1,12 @@
---
sidebar_position: 1
---
# About
## ... StarOpenSource
**The StarOpenSource Project** aims at developing **ethical** and **open source** applications and tools *without* **ads, tracking or analytics**.
<link href="https://sky.staropensource.de/@staropensource"/>
<link href="https://sky.staropensource.de/@soscore"/>
## ... this documentation
The **StarOpenSource Documentation** contains specifications used in StarOpenSource projects, information about the project and much more.

20
docs/projects.md Normal file
View file

@ -0,0 +1,20 @@
---
sidebar_position: 2
description: "Contains a list of all StarOpenSource projects."
---
# Projects
## Projects
### Maintained
- The CORE Framework ([repository](https://git.staropensource.de/StarOpenSource/CORE), [distribution repository](https://git.staropensource.de/StarOpenSource/CORE-distrib), [documentation](https://core.staropensource.de))
- Androot ([repository](https://git.staropensource.de/StarOpenSource/androot))
### Archived
- CORE Manager ([repository](https://git.staropensource.de/StarOpenSource-Archive/core-manager))
- sostools ([repository](https://git.staropensource.de/StarOpenSource-Archive/sostools))
- Jessist ([repository](https://git.staropensource.de/StarOpenSource-Archive/jessist))
- freax ([repository](https://git.staropensource.de))
## Infrastructure-related projects
### Maintained
- soscmd ([repository](https://git.staropensource.de/StarOpenSource-Infrastructure/soscmd))

8
docs/specifications/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "Specifications",
"position": 3,
"link": {
"type": "generated-index",
"description": "Contains various StarOpenSource specifications"
}
}

8
docs/specifications/logging/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "Logging Specification",
"position": 2,
"link": {
"type": "generated-index",
"description": "The StarOpenSource Logging Specification"
}
}

21
docs/specifications/logging/about.md Normal file
View file

@ -0,0 +1,21 @@
---
sidebar_position: 1
description: "Description of the logging specification"
---
# About
The **StarOpenSource Logging Specification** *(**SOSLS**)* is used throughout many StarOpenSource projects and provides a template for custom logger implementations.
## Versions
<table>
<tr>
<th>Version</th>
<th>Released</th>
<th>Links</th>
</tr>
<tr>
<th>1</th>
<th>02.03.2024</th>
<th><a href="/specifications/logging/versions/1/">Specification</a></th>
</tr>
</table>

39
docs/specifications/logging/versions/1.md Normal file
View file

@ -0,0 +1,39 @@
---
sidebar_position: 2
title: "1"
description: "Defines StarOpenSource's logging specification"
---
# Version 1
## Log levels
The **SOSLS** provides five log levels: **Error**, **Warning**, **Info**, **Verbose**, **Diagnostic**
### Crash
In addition to the five levels mentioned above, some implementations might implement a **Crash** level if the language/platform itself does not implement such a feature itself (for example a native crash reporter).
## Placeholders
Every logger implementing the **SOSLS** must have support for these placeholders:
```
Placeholder Description Required?
%time% Current UTC time REQUIRED
%time_runtime% Runtime (in milliseconds) OPTIONAL
%color% Log level color REQUIRED
%level% Log level REQUIRED
%message% Log message REQUIRED
%source% The calling file REQUIRED
%function% The calling function OPTIONAL
%line% The calling line OPTIONAL
```
## Format
One of these two formats must be the default:
```
FORMAT 1 - %line% is implemented
"%color%[%time%] [%level% %source%:%line%] %message%"
FORMAT 2 - %line% is not implemented
"%color%[%time%] [%level %source%] %message%"
```
## Configuration
A **SOSLS**-implementing logger must be configurable with support for changing the log level (enum), the log format (string) aswell as displaying color (boolean, should replace `%color%` with `""` if false).

8
docs/specifications/logging/versions/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "Versions",
"position": 1,
"link": {
"type": "generated-index",
"description": "Contains all SOSLS versions"
}
}

8
docs/specifications/versioning/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "Versioning Specification",
"position": 1,
"link": {
"type": "generated-index",
"description": "The StarOpenSource Versioning Specification"
}
}

21
docs/specifications/versioning/about.md Normal file
View file

@ -0,0 +1,21 @@
---
sidebar_position: 1
description: "Description of the versioning specification"
---
# About
The **StarOpenSource Versioning System** *(**SOSVS**)* is used throughout all StarOpenSource projects and is intended as a clear versioning system, compatible with the semantic versioning system.
## Versions
<table>
<tr>
<th>Version</th>
<th>Released</th>
<th>Links</th>
</tr>
<tr>
<th>1</th>
<th>02.03.2024</th>
<th><a href="/specifications/versioning/versions/1/">Specification</a></th>
</tr>
</table>

91
docs/specifications/versioning/versions/1.md Normal file
View file

@ -0,0 +1,91 @@
---
sidebar_position: 2
title: "1"
description: "Defines StarOpenSource's versioning system"
---
# Version 1
## Format
The StarOpenSource versioning system has four so called **vectors**. These are: **Release**, **Type**, **Typerelease** and **Fork**.
### Release
This the release number and should be used for major changes. It's equivalent to the major and minor numbers in the semantic versioning system. It starts at 1.
### Type
This can be one of four types: **Release** (**r**), **Releasecandidate** (**rc**), **Beta** (**b**) and **Alpha** (**a**)
### Typerelease
This should be the number of releases, releasecandidates, betas or alphas in your current release. It starts at 0.
### Fork
This should be used for identifying forks. This is most commonly used in a soft fork. You can leave this one empty.
## Converting to SemVer
You can convert the StarOpenSource versioning system into the semantic versioning system.
### tl;dr
```
SOSVS:
Release: 5
Type: Releasecandidate
Typerelease: 7
Fork: example
Semantic: 5.2.7-example
```
### Major
The major number is equal to the release number. You don't need to change anything here.
### Minor
The minor number should be set to the type. Set this to **3** for releases, **2** for releasecandidates, **1** for betas and finally to **0** for alphas.
### Patch
The patch number is the same as the typerelease number. Again, you don't need to change anything here.
### Fork
Simply append a dash and then your fork to SemVer.
## Comparison
This table compares features between this specification, semantic versioning and simply increasing a build number without any modification.
<table>
<tr>
<th>Feature</th>
<th>SOSVS</th>
<th>SemVer</th>
<th>Build number</th>
</tr>
<tr>
<th>Easy to understand</th>
<th>Yes</th>
<th>Yes</th>
<th>Yes</th>
</tr>
<tr>
<th>Compatible w/ SemVer</th>
<th>Yes</th>
<th><a href="https://piped.staropensource.de/watch?v=dQw4w9WgXcQ">⠀⠀⠀⠀⠀⠀⠀⠀⠀</a></th> <!-- Let's rickroll those idiots -->
<th>No</th>
</tr>
<tr>
<th>Version type identification</th>
<th>Yes</th>
<th>No</th>
<th>No</th>
</tr>
<tr>
<th>Has alpha/beta/rc/release built-in</th>
<th>Yes</th>
<th>Only 'pre-release'</th>
<th>No</th>
</tr>
<tr>
<th>Forks</th>
<th>Yes</th>
<th>Yes</th>
<th>No</th>
</tr>
<tr>
<th>Highlights incompatibilities</th>
<th>Partial</th>
<th>Yes</th>
<th>No</th>
</tr>
<tr>
<th>Build number</th>
<th>No</th>
<th>Yes</th>
<th>Yes</th>
</tr>
</table>

8
docs/specifications/versioning/versions/_category_.json Normal file
View file

@ -0,0 +1,8 @@
{
"label": "Versions",
"position": 1,
"link": {
"type": "generated-index",
"description": "Contains all SOSVS versions"
}
}

127
docusaurus.config.ts Normal file
View file

@ -0,0 +1,127 @@
import {themes as prismThemes} from "prism-react-renderer";
import type {Config} from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
const config: Config = {
title: "sos!docs",
url: "https://docs.staropensource.de",
baseUrl: "/",
favicon: "dist/core.png",
trailingSlash: true,
i18n: {
defaultLocale: "en",
locales: ["en"],
},
noIndex: false,
onBrokenLinks: "throw",
onBrokenAnchors: "throw",
onBrokenMarkdownLinks: "throw",
onDuplicateRoutes: "warn",
/*
onBrokenLinks: "ignore",
onBrokenAnchors: "ignore",
onBrokenMarkdownLinks: "ignore",
onDuplicateRoutes: "ignore",
*/
tagline: "Documenting StarOpenSource",
themeConfig: {
docs: {
sidebar: {
hideable: false,
autoCollapseCategories: true,
}
},
navbar: {
title: "sos!docs",
logo: {
alt: "sos!docs",
src: "https://fs.staropensource.de/imgs/StarOpenSource_Transparent.png",
},
items: [
{
type: "docSidebar",
sidebarId: "sidebar",
position: "left",
label: "Documentation",
},
{
href: "https://git.staropensource.de/StarOpenSource/website-docs",
label: "Source code",
position: "right",
},
],
},
footer: {
style: "dark",
copyright: `Copyright (c) ${new Date().getFullYear()} The StarOpenSource Project & Contributors<br/>Licensed under the CC BY-NC-SA license, version 4.0.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
presets: [
[
"classic",
{
debug: false,
docs: {
path:
"docs",
editUrl: "https://git.staropensource.de/StarOpenSource/website-docs/_edit/develop/",
editLocalizedFiles: false,
editCurrentVersion: true,
routeBasePath: "",
tagsBasePath: 'tags',
sidebarPath: "./sidebars.ts",
sidebarCollapsible: false,
sidebarCollapsed: false,
showLastUpdateAuthor: true,
showLastUpdateTime: true,
breadcrumbs: true,
includeCurrentVersion: true,
},
sitemap: {
changefreq: "monthly",
priority: 0.5,
filename: "sitemap.xml"
},
theme: {
customCss: "./src/css/custom.css",
},
} satisfies Preset.Options,
],
],
plugins: [
[
"@docusaurus/plugin-client-redirects",
{
fromExtensions: ["html", "htm", "php"],
redirects: [
{
from: ["/", "/index"],
to: "/about",
},
],
}
],
],
markdown: {
format: "detect",
mermaid: false,
},
staticDirectories: ["static"],
titleDelimiter: "»",
baseUrlIssueBanner: true,
};
export default config;

14636
package-lock.json generated Normal file
View file

File diff suppressed because it is too large Load diff

49
package.json Normal file
View file

@ -0,0 +1,49 @@
{
"name": "docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
},
"dependencies": {
"@docusaurus/core": "3.1.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/plugin-content-docs": "^3.1.1",
"@docusaurus/plugin-sitemap": "^3.1.1",
"@docusaurus/preset-classic": "3.1.1",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.1.1",
"@docusaurus/tsconfig": "3.1.1",
"@docusaurus/types": "3.1.1",
"@types/node": "^20.11.0",
"typescript": "~5.2.2"
},
"browserslist": [
"> 0.5%",
"> 0.5% in cn",
"not dead",
"not op_mini all",
"firefox esr",
"last 3 chrome version",
"last 3 firefox version",
"last 3 safari version"
],
"engines": {
"node": ">=18.0"
}
}

20
sidebars.ts Normal file
View file

@ -0,0 +1,20 @@
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
sidebar: [{type: 'autogenerated', dirName: '.'}],
// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};
export default sidebars;

24
src/css/custom.css Normal file
View file

@ -0,0 +1,24 @@
:root {
--ifm-color-primary: #d60532;
--ifm-color-primary-dark: #c4052e;
--ifm-color-primary-darker: #af072b;
--ifm-color-primary-darkest: #990525;
--ifm-color-primary-light: #db1943;
--ifm-color-primary-lighter: #ec2c56;
--ifm-color-primary-lightest: #fa3e67;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode.
Note from JeremyStarTM: Readability concerns? It looks beautiful! */
[data-theme='dark'] {
--ifm-color-primary: #d60532;
--ifm-color-primary-dark: #c4052e;
--ifm-color-primary-darker: #af072b;
--ifm-color-primary-darkest: #990525;
--ifm-color-primary-light: #db1943;
--ifm-color-primary-lighter: #ec2c56;
--ifm-color-primary-lightest: #fa3e67;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}

23
src/pages/index.module.css Normal file
View file

@ -0,0 +1,23 @@
/**
* CSS files with the .module.css suffix will be treated as CSS modules
* and scoped locally.
*/
.heroBanner {
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
}
@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
}
}
.buttons {
display: flex;
align-items: center;
justify-content: center;
}

27
src/pages/index.tsx Normal file
View file

@ -0,0 +1,27 @@
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import Heading from '@theme/Heading';
import styles from './index.module.css';
export default function Home(): JSX.Element {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={``}
description="The Presencode documentation">
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<Heading as="h1" className="hero__title">You shouldn't see this.</Heading>
<p className="hero__subtitle">You should have been redirected to the <b>About</b> page.</p>
<div className={styles.buttons}>
<Link className="button button--secondary button--lg" to="/about">Click here to get there
</Link>
</div>
</div>
</header>
</Layout>
);
}

0
static/.nojekyll Normal file
View file

8
tsconfig.json Normal file
View file

@ -0,0 +1,8 @@
{
// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"jsx": "react",
"baseUrl": "."
}
}