[PATCH olang 0/5] docs: some improvements on the website

[PATCH olang 0/5] docs: some improvements on the website

[Carlos Maniero]

Apart of the first patch, all patches are independent (I believe). The
main point is to make the website even cleaner and simple. Almost like
accessing it from the w3m and other small adjustments.

Carlos Maniero (5):
  docs: unify manual and site style
  docs: include the manual link over the manual
  docs: make the olang visuals a w3m like website
  docs: prevents the menu items to break line
  docs: home page: transform the unfinished software warn into a notice

 docs/Makefile               |  6 ++-
 docs/index.md               | 15 ++++---
 docs/manual/Makefile        |  2 +-
 docs/manual/_header.html    | 15 +++----
 docs/{manual => }/style.css | 33 ++++++++++------
 docs/template.html          | 78 +++----------------------------------
 6 files changed, 50 insertions(+), 99 deletions(-)
 rename docs/{manual => }/style.css (77%)


base-commit: ffd6333175b2c49996731bcf0d224b4f9cac760c
-- 
2.34.1

[PATCH olang 1/5] docs: unify manual and site style

[Carlos Maniero]

We were duplicating code, now they point to a single source.

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
 docs/Makefile               |  6 +++-
 docs/manual/Makefile        |  2 +-
 docs/{manual => }/style.css |  0
 docs/template.html          | 68 +------------------------------------
 4 files changed, 7 insertions(+), 69 deletions(-)
 rename docs/{manual => }/style.css (100%)

diff --git a/docs/Makefile b/docs/Makefile
index b57617a..ae5e546 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -4,13 +4,14 @@ BUILD_DIR  := build
 SITE_DIR   := $(BUILD_DIR)/site
 TARGET     := $(SITE_DIR)/index.html
 DIST_FILE  := site.tar.gz
+STYLE      := style.css
 PAGES_DIR  := pages
 MANPAGES   := $(BUILD_DIR)/man
 PAGES      := $(wildcard $(PAGES_DIR)/*.md)
 HTML_PAGES := $(patsubst $(PAGES_DIR)/%.md, $(SITE_DIR)/$(PAGES_DIR)/%.html, $(PAGES))
 
 .PHONY: all
-all:  $(BUILD_DIR) $(TARGET) $(PAGES) manpages manual
+all:  $(BUILD_DIR) $(STYLE) $(TARGET) $(PAGES) manpages manual
 
 .PHONY: clean
 clean:
@@ -42,6 +43,9 @@ $(BUILD_DIR):
 	@mkdir -p $(SITE_DIR)/$(PAGES_DIR)
 	@mkdir -p $(MANPAGES)
 
+$(STYLE): $(BUILD_DIR)
+	cp style.css $(SITE_DIR)
+
 $(SITE_DIR)/manual/index.html: manual/*.texi
 	make -C manual
 	rm -rf $(SITE_DIR)/manual
diff --git a/docs/manual/Makefile b/docs/manual/Makefile
index 2bafbe6..59aeb03 100644
--- a/docs/manual/Makefile
+++ b/docs/manual/Makefile
@@ -5,7 +5,7 @@ HTML_HEADER=$(shell cat _header.html)
 all: html
 
 html: olang.texi introduction.texi installation.texi getting-started.texi contribution-guide.texi
-	$(MAKEINFO) --set-customization-variable AFTER_BODY_OPEN="$(HTML_HEADER)" --css-include=style.css -o html --html olang.texi
+	$(MAKEINFO) --set-customization-variable AFTER_BODY_OPEN="$(HTML_HEADER)" --css-include=../style.css -o html --html olang.texi
 
 .PHONY: clean
 clean:
diff --git a/docs/manual/style.css b/docs/style.css
similarity index 100%
rename from docs/manual/style.css
rename to docs/style.css
diff --git a/docs/template.html b/docs/template.html
index e81f53e..ab4b5a6 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -5,73 +5,7 @@
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta name="date" content='$date-meta$'>
   <title>$title$ | olang</title>
-  <style>
-    :root {
-      --background-color: #f4f4f4;
-      --text-color: black;
-      --link-color: #4e5289;
-    }
-
-    @media (prefers-color-scheme: dark) {
-      :root {
-        --background-color: #26282B;
-        --text-color: white;
-        --link-color: #8c91db;
-      }
-    }
-
-    body {
-      background: var(--background-color);
-      color: var(--text-color);
-      font-family: monospace;
-      font-size: 1rem;
-      margin: 0;
-      padding: 0 40px;
-    }
-
-    a {
-      color: var(--link-color);
-    }
-
-    article, nav, header, footer {
-      max-width: 80ch;
-      margin: 10px auto;
-    }
-
-    header > h1 {
-      font-weight: normal;
-    }
-
-    nav, header > h1 {
-      text-align: center;
-    }
-
-    header {
-      margin-top: 70px;
-      margin-bottom: 20px;
-    }
-
-    footer {
-      margin: 20px auto;
-    }
-
-    article {
-      overflow: hidden;
-    }
-
-    pre {
-      background: rgba(0,0,0, 0.75);
-      color: white;
-      padding: 10px;
-      max-width: 100%;
-      overflow: auto;
-      font-size: large;
-    }
-
-    .logo-name {
-      font-weight: bold;
-    }
-  </style>
+  <link rel="stylesheet" href="/style.css">
 </head>
 <body>
   <header>
-- 
2.34.1

[PATCH olang 2/5] docs: include the manual link over the manual

[Carlos Maniero]

There are two main reasons for this change:

  1. consistency: no other page has this behavior, the specification and
     the home still enabled even when they are the current page.
  2. texinfo navigation is not so intuitive and I'm not confident the
     people will understand that if they click on the "[ Contents ]"
     link they will be redirected to the manual home page, so I believe
     that is convenient to have the manual link enabled.

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
 docs/manual/_header.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/manual/_header.html b/docs/manual/_header.html
index 41eae20..9e25295 100644
--- a/docs/manual/_header.html
+++ b/docs/manual/_header.html
@@ -4,7 +4,7 @@
   </h1>
   <nav>
     [ <a href="/">Home</a> ]
-    [ <strong>Manual</strong> ]
+    [ <a href="/manual/">Manual</a> ]
     [ <a href="/pages/language-specification.html">Specification</a> ]
     [ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources &UpperRightArrow;</a> ]
     [ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]
-- 
2.34.1

[PATCH olang 3/5] docs: make the olang visuals a w3m like website

[Carlos Maniero]

This commit makes all font-sizes to be the same, in a way it seems
almost the same in the browser and in the w3m.

I think this is great because we don't need to worrie too much about
font-sizes and enforces the need to build a readable plain text once you
have not much textual style to help you to highlight suff.

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
 docs/manual/_header.html |  1 -
 docs/style.css           | 33 ++++++++++++++++++++-------------
 2 files changed, 20 insertions(+), 14 deletions(-)

diff --git a/docs/manual/_header.html b/docs/manual/_header.html
index 9e25295..e9a973f 100644
--- a/docs/manual/_header.html
+++ b/docs/manual/_header.html
@@ -10,4 +10,3 @@
     [ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]
   </nav>
 </header>
-<hr/>
diff --git a/docs/style.css b/docs/style.css
index c9b366f..bccbb68 100644
--- a/docs/style.css
+++ b/docs/style.css
@@ -36,36 +36,42 @@ body {
   background-color: var(--text-highlight-color);
 }
 
+.settitle {
+  text-align: left !important;
+}
+
 a {
   color: var(--link-color);
 }
 
-body > * {
-  max-width: 80ch;
-  margin: 10px auto;
+h1, h2, h3, h4, h5, h6 {
+  font-size: 1em;
+  margin: 0;
+  margin-bottom: 1ch;
 }
 
-header > h1 {
-  font-weight: normal;
+body > * {
+  max-width: 80ch;
+  margin: 0 auto;
 }
 
-nav, header > h1 {
-  text-align: center;
+header {
+  margin: 6ch auto;
 }
 
-header {
-  margin-top: 70px;
-  margin-bottom: 20px;
+header > h1 {
+  font-weight: normal;
+  font-size: 1em;
 }
 
 footer {
-  margin: 20px auto;
+  margin: 4ch auto;
 }
 
 pre {
   background: rgba(0,0,0, 0.75);
   color: white;
-  padding: 1.5rem;
+  padding: 1.5em;
   max-width: 100%;
   overflow: auto;
   font-size: large;
@@ -79,9 +85,10 @@ pre {
 hr {
   border: none;
   height: 1px;
+  opacity: 0.5;
   background-color: var(--text-color);
 }
 
 ol {
-  margin-left: 1.5rem;
+  margin-left: 1.5em;
 }
-- 
2.34.1

[PATCH olang 4/5] docs: prevents the menu items to break line

[Carlos Maniero]

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
 docs/manual/_header.html | 14 ++++++--------
 docs/style.css           |  4 ++++
 docs/template.html       | 10 +++++-----
 3 files changed, 15 insertions(+), 13 deletions(-)

diff --git a/docs/manual/_header.html b/docs/manual/_header.html
index e9a973f..e45d4b9 100644
--- a/docs/manual/_header.html
+++ b/docs/manual/_header.html
@@ -1,12 +1,10 @@
 <header>
-  <h1>
-    <span class="logo-name">olang</span> | O Programming Language
-  </h1>
+  <h1><span class="logo-name">olang</span> | O Programming Language</h1>
   <nav>
-    [ <a href="/">Home</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 &UpperRightArrow;</a> ]
-    [ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]
+    <span>[ <a href="/">Home</a> ]</span>
+    <span>[ <a href="/manual/">Manual</a> ]</span>
+    <span>[ <a href="/pages/language-specification.html">Specification</a> ]</span>
+    <span>[ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources &UpperRightArrow;</a> ]</span>
+    <span>[ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]</span>
   </nav>
 </header>
diff --git a/docs/style.css b/docs/style.css
index bccbb68..d6cf74a 100644
--- a/docs/style.css
+++ b/docs/style.css
@@ -64,6 +64,10 @@ header > h1 {
   font-size: 1em;
 }
 
+header > nav > span {
+  white-space: nowrap;
+}
+
 footer {
   margin: 4ch auto;
 }
diff --git a/docs/template.html b/docs/template.html
index ab4b5a6..e4649b8 100644
--- a/docs/template.html
+++ b/docs/template.html
@@ -11,11 +11,11 @@
   <header>
     <h1><span class="logo-name">olang</span> | O Programming Language</h1>
     <nav>
-      [ <a href="/">Home</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 &UpperRightArrow;</a> ]
-      [ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]
+      <span>[ <a href="/">Home</a> ]</span>
+      <span>[ <a href="/manual/">Manual</a> ]</span>
+      <span>[ <a href="/pages/language-specification.html">Specification</a> ]</span>
+      <span>[ <a href="https://sr.ht/~johnnyrichard/olang/sources" target="_blank">Sources &UpperRightArrow;</a> ]</span>
+      <span>[ <a href="https://sr.ht/~johnnyrichard/olang/lists" target="_blank">Mailing list &UpperRightArrow;</a> ]</span>
     </nav>
   </header>
   <article>
-- 
2.34.1

[PATCH olang 5/5] docs: home page: transform the unfinished software warn into a notice

[Carlos Maniero]

No fool would try to use olang at the current stage. IMO, This
uppercased warning was catching the readers eyes and would distract them
to understand what olang is.

Signed-off-by: Carlos Maniero <carlos@maniero.me>
---
 docs/index.md | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index 82c4ef3..13aab32 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,7 +1,5 @@
 % Introduction
 
-**[WARNING] THIS SOFTWARE IS UNFINISHED AND NOT PRODUCTION READY**
-
 The O language is a system programming language crafted to be remarkably simple
 and flexible. It stands not as a replacement for C, but rather as a
 complementary counterpart, as both can coexist within the same source code. O
@@ -10,6 +8,13 @@ almost predictable machine code.
 
 olang is a deterministic system language that follows tree principles:
 
-- **fights complexity** by providing a simple syntax with a low level of abstraction.
-- **doesn't babysit programmers**, it gives you the freedom of shooting your own foot.
-- **aims easy maintainability** by providing a syntax with a low refactoring overhead.
+- **fights complexity** by providing a simple syntax with a low level of
+  abstraction.
+- **doesn't babysit programmers**, it gives you the freedom of shooting your
+  own foot.
+- **aims easy maintainability** by providing a syntax with a low refactoring
+  overhead.
+
+## Notice
+
+This software is unfinished and not production ready.
-- 
2.34.1

Re: [PATCH olang 0/5] docs: some improvements on the website

[Johnny Richard]

Thanks for your contribution, patchset applied!

Build: https://builds.sr.ht/~johnnyrichard/job/1321625

To git.sr.ht:~johnnyrichard/olang
   ffd6333..3804832  main -> main