More links and community tools

This commit is contained in:
Cadence Ember 2022-09-05 15:33:39 +12:00
parent bc50f55b46
commit 94da99ea5d
Signed by: cadence
GPG Key ID: BC1C2C61CF521B17
2 changed files with 58 additions and 10 deletions

View File

@ -42,12 +42,32 @@ h3 {
h4 {
font-size: 1.3em;
}
h5 {
font-size: 1.1em;
}
.boxed, .SVerbatim, .stt {
background-color: rgb(232, 232, 255);
font-size: 0.90em;
}
.user-table {
border-collapse: collapse;
}
.user-table--title tr:first-child td {
font-weight: bold;
}
.user-table td {
border: solid black;
padding: 4px;
border-width: 1px 0px;
}
.user-table td + td {
padding-left: 8px;
}
@media (max-width: 600px) {
body {
grid-template-columns: 1fr;

View File

@ -1,6 +1,6 @@
#lang scribble/base
@(require scribble/manual)
@(require scribble/manual scribble/core racket/list)
@(define (code . pre-content) (elem (apply literal pre-content) #:style 'tt))
@title{BreezeWiki Documentation}
@ -13,13 +13,41 @@
@section{Links}
@itemlist[
@item{Source code: @url{https://gitdab.com/cadence/breezewiki}}
@item{Source code of documentation: @url{https://gitdab.com/cadence/breezewiki-docs}}
@item{How to bug report or feature request: @Secref["Reporting Bugs"]}
@item{Planned features: <TODO>}
@item{Community: @url{https://matrix.to/#/#breezewiki:cadence.moe}}
]
@subsection{Official}
@tabular[#:style (style "user-table" null)
(map (λ (row) (list (first row) (if (string? (second row)) (url (second row)) (second row))))
`(("Official website" "https://breezewiki.com")
("Community" "https://matrix.to/#/#breezewiki:cadence.moe")
("How to bug report or feature request" ,(Secref "Reporting Bugs"))
("Planned features" "https://todo.sr.ht/~cadence/breezewiki-todo")
("Source code" "https://gitdab.com/cadence/breezewiki")
("Documentation source" "https://gitdab.com/cadence/breezewiki-docs")
))]
@subsection{Instances}
@tabular[#:style (style "user-table instance-list user-table--title" null)
(map (λ (row) (list (if (string? (second row)) (hyperlink (second row) (first row)) (first row))
(if (string? (third row)) (url (third row)) (third row))))
`((,(literal "Hoster") #f ,(literal "Link"))
("Cadence" "https://cadence.moe" "https://breezewiki.com")
("PussTheCat" "https://pussthecat.org" "https://breezewiki.pussthecat.org")
))]
@subsection{Tools}
@subsubsection{Cadence's redirector}
@url{https://docs.breezewiki.com/files/redirector.user.js}
Displays a giant banner with a link to send you to BreezeWiki.
@subsubsection{barr0w's redirector}
@url{http://alphamethyl.barr0w.net/~barrow/src/barrownet_ca_redirector/breezewiki_redirector.user.js}
Just sends you to BreezeWiki.
@; -----------------------------------------------------------------------------
@ -29,7 +57,7 @@ Bug reports are important, and so are feature requests! Thank you for your inter
There is the @italic{mailing list} which is the first line for people like you to report to. Once a bug is confirmed, I will copy it onto the @italic{todo tracker} as a task item.
Please spend one minute checking the todo tracker so you don't submit a duplicate of somebody else's report.
Please spend one minute @hyperlink["https://todo.sr.ht/~cadence/breezewiki-todo" "checking the todo tracker"] so you don't submit a duplicate of somebody else's report.
For real-time chat with the community, check out @url{https://matrix.to/#/#breezewiki:cadence.moe}.
@ -58,7 +86,7 @@ This method is recommended for people who do not want to edit the source code.
The distribution includes the Racket runtime, libraries, and everything else needed to run BreezeWiki.
@itemlist[#:style 'ordered
@item{Download the distribution: @url{https://cadence.moe/friends/breezewiki-dist.tar.gz}}
@item{Download the distribution: @url{https://docs.breezewiki.com/files/breezewiki-dist.tar.gz}}
@item{Unpack the archive.}
@item{Execute the binary @code{breezewiki-dist/bin/dist}.}
]