From: Johnny Richard <johnny@johnnyrichard.com>
To: Carlos Maniero <carlos@maniero.me>
Cc: ~johnnyrichard/olang-devel@lists.sr.ht
Subject: Re: [PATCH olang v1] docs: Create olang manual document bootstrap
Date: Fri, 6 Sep 2024 16:49:10 +0200 [thread overview]
Message-ID: <6cf2oxsllqw7rz5kmtkp4xwkkmdbqwmaxex6axvblj4iw3esqv@7qkb4s34dhuo> (raw)
In-Reply-To: <D3YPWP8NWQ33.3SXYFPUW1SXA6@maniero.me>
Thanks for reviewing it. I found few issues with the patch (build and
styling) and adjusted in a fixup commit bellow:
Build: https://builds.sr.ht/~johnnyrichard/job/1320980
To git.sr.ht:~johnnyrichard/olang
b1023a7..be71d16 HEAD -> main
---->8----
Subject: [PATCH olang] fixup! docs: Create olang manual document bootstrap
diff --git a/.build.yml b/.build.yml
index 01f4aab..3cbba82 100644
--- a/.build.yml
+++ b/.build.yml
@@ -6,6 +6,7 @@ packages:
- hut
- clang
- pandoc-cli
+ - texinfo
environment:
site: o-lang.org
sources:
diff --git a/docs/manual/contribution-guide.texi b/docs/manual/contribution-guide.texi
index 4c6e458..856d0f6 100644
--- a/docs/manual/contribution-guide.texi
+++ b/docs/manual/contribution-guide.texi
@@ -6,7 +6,7 @@ the world. Everyone is welcome to join us. If you want to catch up the language
development, you can subscribe to our mailing list or join the #olang IRC
channel on Libera network.
-Olang is hosted on a @strong{git repository}
+Olang source code is available on @strong{git}
@url{https://git.sr.ht/~johnnyrichard/olang}
@c ----------------------------------------------------------------------------
@@ -136,15 +136,12 @@ Any additional comments not suitable for the changelog
The actual patch (@code{diff} output).
@end enumerate
-
Sometimes you might need to break down your patch into multiple patches. In
this case a patchset should be sent.
-
Patchesets MUST contain a @strong{cover letter} followed by a good description.
It is easily achievable with the @code{--cover-letter} argument available on
@code{git format-patch} and @code{git send-email} commands.
-
@subsection Creating Patches
You can create a patch using the command:
@@ -231,7 +228,7 @@ $ git format-patch --cover-letter -M origin/main -o outgoing/ -v2
Whenever you need to reply emails comments, please avoid
@url{https://en.wikipedia.org/wiki/Posting_style, top posting}, do
-@strong{botton posting} instead. Read more about it here
+@strong{bottom posting} instead. Read more about it here
@url{https://useplaintext.email/#etiquette}.
@c ----------------------------------------------------------------------------
@@ -246,7 +243,7 @@ Whenever you need to reply emails comments, please avoid
Send a @strong{plain text} email to
@email{~johnnyrichard/olang-devel+subscribe@@lists.sr.ht} to subscribe to our
-deve mailing list.
+dev mailing list.
You should be able to find older threads by searching into our archives, which
is hosted at @url{https://lists.sr.ht/~johnnyrichard/olang-devel}.
diff --git a/docs/manual/style.css b/docs/manual/style.css
index 41b1b3f..db32c05 100644
--- a/docs/manual/style.css
+++ b/docs/manual/style.css
@@ -1,32 +1,3 @@
-@font-face {
- font-family: 'Red Hat Mono';
- font-style: italic;
- font-weight: 300;
- font-display: swap;
- src: url(https://johnnyrichard.com/static/fonts/RedHatMono-Italic.ttf) format('truetype');
-}
-@font-face {
- font-family: 'Red Hat Mono';
- font-style: italic;
- font-weight: 500;
- font-display: swap;
- src: url(https://johnnyrichard.com/static/fonts/RedHatMono-BoldItalic.ttf) format('truetype');
-}
-@font-face {
- font-family: 'Red Hat Mono';
- font-style: normal;
- font-weight: 300;
- font-display: swap;
- src: url(https://johnnyrichard.com/static/fonts/RedHatMono-Regular.ttf) format('truetype');
-}
-@font-face {
- font-family: 'Red Hat Mono';
- font-style: normal;
- font-weight: 500;
- font-display: swap;
- src: url(https://johnnyrichard.com/static/fonts/RedHatMono-SemiBold.ttf) format('truetype');
-}
-
:root {
--background-color: #f4f4f4;
--text-color: black;
@@ -41,10 +12,6 @@
}
}
-h1, h2, h3, h4, h5, h6, b, strong {
- font-weight: 500;
-}
-
div.example {
margin: 0;
}
@@ -54,12 +21,12 @@ body {
color: var(--text-color);
margin: 0;
padding: 0 40px;
+ font-size: 11pt;
+ font-family: monospace;
}
-body, pre {
- font-weight: 300;
- font-family: "Red Hat Mono";
- font-size: 1.4rem;
+.example-formatted {
+ font-family: monospace;
}
a {
@@ -67,7 +34,7 @@ a {
}
body > * {
- max-width: 1024px;
+ max-width: 800px;
margin: 10px auto;
}
@@ -89,7 +56,6 @@ footer {
}
body > * {
- line-height: 1.75rem;
overflow: hidden;
}
diff --git a/docs/template.html b/docs/template.html
index 0f5a207..be5cbf5 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -70,7 +70,7 @@
<h1><span class="logo-name">olang</span> | O Programming Language</h1>
<nav>
[ <a href="/">Home</a> ]
- [ <a href="/manual">Manual</a> ]
+ [ <a href="/manual/">Manual</a> ]
[ <a href="/pages/language-specification.html">Specification</a> ]
[ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources ↗</a> ]
[ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list ↗</a> ]
prev parent reply other threads:[~2024-09-06 14:49 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-05 19:38 Johnny Richard
2024-09-05 22:52 ` Carlos Maniero
2024-09-06 14:49 ` Johnny Richard [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=6cf2oxsllqw7rz5kmtkp4xwkkmdbqwmaxex6axvblj4iw3esqv@7qkb4s34dhuo \
--to=johnny@johnnyrichard.com \
--cc=carlos@maniero.me \
--cc=~johnnyrichard/olang-devel@lists.sr.ht \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.johnnyrichard.com/olang.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox