Compare commits

...

16 Commits

Author SHA1 Message Date
6538d4bd05
Add ".editorconfig"
This allows customisation of the behaviour of the front-end in regards
to indent styles and indent sizes, among other options.
2024-02-15 08:18:01 +00:00
6426f70ac4
Switch from shorthand IDs to longhand 2023-08-15 23:12:38 +01:00
2a629f2d40
Add missing custom heading anchors 2023-08-15 23:12:04 +01:00
d71756613f
Add heading link role 2023-08-15 23:10:44 +01:00
be549fb64e
Switch to custom heading anchors 2023-08-14 19:04:28 +01:00
17bd5b864f
Fix repository URIs 2023-07-15 04:39:12 +01:00
b9512f1bc9
Refactor code to conform with coding style
Commit a8ba04ee41df9601ff3a7d1efd14581d843d749e allowed 120-column line
length, which is allowed only for indented lines. This commit corrects
this to 100-column line length for unindented lines.
2023-07-15 04:05:50 +01:00
2e91e733d6
Add spec branch 2023-07-13 22:03:18 +01:00
a8ba04ee41
Refactor code to conform with 120-column coding style 2023-07-13 22:01:52 +01:00
26d281641a
Move Security section above Licensing section 2023-07-13 22:00:02 +01:00
56da7ca1ac
Move Branches section to top 2023-07-13 21:58:42 +01:00
13ba140b4e
Improve readme code readability. 2023-06-07 11:46:27 +01:00
ac28eca2cc
Fix readme AsciiDoc syntax. 2023-05-15 01:28:35 +01:00
5398be7791
Fix headings to have paragraphs as children rather than siblings. 2023-05-12 01:57:10 +01:00
1114ae1928
Rewrite readme in AsciiDoc. 2023-05-12 01:49:58 +01:00
b91e89fb43
Add security branch to readme. 2023-05-09 17:46:00 +01:00
4 changed files with 91 additions and 33 deletions

28
.editorconfig Normal file
View File

@ -0,0 +1,28 @@
root = true
[*]
indent_style = tab
indent_size = 4
tab_width = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false
[*.{go,tmpl,html}]
indent_style = tab
[templates/custom/*.tmpl]
insert_final_newline = false
[templates/swagger/v1_json.tmpl]
indent_style = space
[templates/user/auth/oidc_wellknown.tmpl]
indent_style = space
[Makefile]
indent_style = tab
[*.svg]
insert_final_newline = false

View File

@ -1,33 +0,0 @@
# Documentation
Inferencium documentation.<br>
<br>
## Licensing
All content is licensed under <a href="https://git.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt">Creative Commons Attribution 4.0 International</a> license.<br>
<br>
## Security
All files are checked for security issues; however, it is always the user's responsibility to
audit the code before installing and/or executing it.<br>
<br>
Inferencium takes no responsibility for any security issues which may arise due to usage of this
repository.<br>
<br>
## Branches
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/main/">main</a>
Documentation root directory files pre-alpha development and alpha testing occurs in this
branch.<br>
Feature-complete modifications of this branch are merged to beta branch for beta testing.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/license/">license</a>
Documentation license files pre-alpha and alpha testing occurs in this branch.<br>
Feature-complete modifications of this branch are merged to beta branch for beta testing.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/beta/">beta</a>
Feature-complete beta testing of merged code from development branches occurs in this branch.<br>
Merges from development branches to this branch are squashed, and the updated versions of the
individual files are mentioned in the commit messages.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/stable/">stable</a>
Feature-complete and tested versions from beta branch are stored in this branch.<br>
Merges from beta branch to this branch are squashed, and the updated versions of the individual
files are mentioned in the commit messages.<br>
This branch contains code used in production.

6
docinfo.html Normal file
View File

@ -0,0 +1,6 @@
<style>
h1, h2, h3, h4, h5, h6, .h-link {
color: #ffffff;
font-style: bold;
}
</style>

57
readme.adoc Normal file
View File

@ -0,0 +1,57 @@
= Documentation
:docinfo: shared
Inferencium documentation.
[id=branches]
== [.h-link]#<<branches,Branches>>#
=== https://src.inferencium.net/Inferencium/doc/src/branch/main/[main]
Documentation root directory files pre-alpha development and alpha testing occurs in this branch. +
Feature-complete modifications of this branch are merged to beta branch for beta testing.
=== https://src.inferencium.net/Inferencium/doc/src/branch/security/[security]
Documentation security files pre-alpha development and alpha testing occurs in this branch. +
Feature-complete modifications of this branch are merged to beta branch for beta testing.
=== https://src.inferencium.net/Inferencium/doc/src/branch/spec/[spec]
Documentation specification files pre-alpha development and alpha testing occurs in this branch. +
Feature-complete modifications of this branch are merged to beta branch for beta testing.
=== https://src.inferencium.net/Inferencium/doc/src/branch/license/[license]
Documentation license files pre-alpha and alpha testing occurs in this branch. +
Feature-complete modifications of this branch are merged to beta branch for beta testing.
=== https://src.inferencium.net/Inferencium/doc/src/branch/beta/[beta]
Feature-complete beta testing of merged code from development branches occurs in this branch. +
Merges from development branches to this branch are squashed, and the updated versions of the
individual files are mentioned in the commit messages.
=== https://src.inferencium.net/Inferencium/doc/src/branch/stable/[stable]
Feature-complete and tested versions from beta branch are stored in this branch. +
Merges from beta branch to this branch are squashed, and the updated versions of the individual
files are mentioned in the commit messages. +
This branch contains code used in production.
[id=security]
== [.h-link]#<<security,Security>>#
All files are checked for security issues; however, it is always the user's responsibility to audit
the code before installing and/or executing it. Inferencium takes no responsibility for any security
issues which may arise due to usage of this repository.
[id=licensing]
== [.h-link]#<<licensing,Licensing>>#
All content is licensed under
https://src.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt[Creative Commons Attribution 4.0 International]
license.