Update content

trustoverip · Jul 9, 2024 · db1d7c9 · db1d7c9
1 parent e265d2e
commit db1d7c9
Show file tree

Hide file tree

Showing 17 changed files with 81 additions and 38 deletions.
diff --git a/docs/admin-guide.md b/docs/admin-guide.md
@@ -1,7 +1,7 @@
 ---
-sidebar_position: 2
+sidebar_position: 20
 ---
 
-# Installation
+# Admin Guide
 
 The installation process is described [in the readme.md on the Spec-Up-T repo site](https://github.com/blockchainbird/spec-up-t/blob/master/readme.md)
diff --git a/docs/content-author-guide/_category_.json b/docs/content-author-guide/_category_.json
@@ -1,8 +1,8 @@
 {
-  "label": "Authors Guide",
-  "position": 3,
+  "label": "Content Authors Guide",
+  "position": 2,
   "link": {
     "type": "generated-index",
-    "description": "Authors Guide."
+    "description": "Content Authors Guide."
   }
 }
diff --git a/docs/content-author-guide/introduction.md b/docs/content-author-guide/introduction.md
@@ -2,14 +2,6 @@
 sidebar_position: 1
 ---
 
-# Introduction
+# Content Author Guide
 
-## Markdown
-
-Authors must write in Markdown.
-
-Spec-Up-T is a simple tool that auto-generates specs from markdown. The version of markdown Spec-Up-T uses contains all the same features you might expect from common implementations, like GitHub, but adds much more, including notice blocks, complex tables, charts, advanced syntax highlighting, UML diagrams, etc.
-
-> Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages.
-
-Read more about [Markdown](https://www.markdownguide.org/getting-started/)
+Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions.
diff --git a/docs/curators-guide/_category_.json → docs/curator-guide/_category_.json b/docs/curators-guide/_category_.json → docs/curator-guide/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Curators Guide",
-  "position": 4,
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "Curators Guide."

diff --git a/docs/curator-guide/introduction.md b/docs/curator-guide/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Curator Guide
+
+Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context and uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors.
diff --git a/docs/curators-guide/term-references.md → docs/curator-guide/term-references.md b/docs/curators-guide/term-references.md → docs/curator-guide/term-references.md
diff --git a/docs/glossary-maintainer-guide/_category_.json b/docs/glossary-maintainer-guide/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Glossary Maintainer Guide",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Glossary Maintainer Guide."
+  }
+}
diff --git a/docs/glossary-maintainer-guide/introduction.md b/docs/glossary-maintainer-guide/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Glossary Maintainer Guide
+
+Uses: Source management tool. Reads and compares concepts in text and terminology in glossaries, (for example generated by Spec-Up) to use within his/hers “own” over-arching ToIP glossary. He/she builds as much consensus around terms and concepts and promotes using the ToIP glossary as reference material.
diff --git a/docs/intro.md b/docs/intro.md
@@ -12,23 +12,18 @@ Spec-Up-T is a tool that helps you write specifications. It is a tool for writin
 
 The following roles can be distinguished:
 
-- content author
-- termsdef author
-- curator
-- admin
+- [Content Author](content-author-guide/introduction), focusses on content and concepts of the group he/she belongs to.
+- [Terminology Author](terminology-author-guide/introduction), focusses on term definitions covering concepts of the group he/she belongs to.
+- [Curator](curator-guide/introduction), checks logical consistency & meaning of term definition in a certain context.
+- [Reader](reader-guide/introduction.md), reads concepts in text and terminology in glossaries.
+- [Admin](admin-guide), installs, updates and maintains Spec-Up-T.
 
-### content author
+## Markdown
 
-Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions.
+Authors must write in Markdown.
 
-### termsdef author
+Spec-Up-T is a simple tool that auto-generates specs from markdown. The version of markdown Spec-Up-T uses contains all the same features you might expect from common implementations, like GitHub, but adds much more, including notice blocks, complex tables, charts, advanced syntax highlighting, UML diagrams, etc.
 
-*To be written.*
+> Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages.
 
-### curator
-
-Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context and uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors.
-
-### admin
-
-*To be written.*
+Read more about [Markdown](https://www.markdownguide.org/getting-started/)
diff --git a/docs/reader-guide/_category_.json b/docs/reader-guide/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Reader Guide",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Reader Guide."
+  }
+}
diff --git a/docs/reader-guide/introduction.md b/docs/reader-guide/introduction.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 1
+---
+
+# Readers Guide
+
+Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.
diff --git a/...tent-author-guide/spec-up-t-demo-site.mdx → docs/spec-up-t-demo-site.mdx b/...tent-author-guide/spec-up-t-demo-site.mdx → docs/spec-up-t-demo-site.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 ---
 
 import IframeComponent from '@site/src/components/IframeComponent';

diff --git a/docs/terminology-author-guide/_category_.json b/docs/terminology-author-guide/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Terminology Author Guide",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Terminology Author Guide."
+  }
+}
diff --git a/...-author-guide/external-term-references.md → ...-author-guide/external-term-references.md b/...-author-guide/external-term-references.md → ...-author-guide/external-term-references.md
diff --git a/docs/terminology-author-guide/introduction.md b/docs/terminology-author-guide/introduction.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 1
+---
+
+# Terminology Author Guide
+
+Focusses on term definitions covering concepts of the group he/she belongs to.
+
+Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR. He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions. Specification author terms that cover those concepts.
diff --git a/docs/content-author-guide/term-references.md → ...rminology-author-guide/term-references.md b/docs/content-author-guide/term-references.md → ...rminology-author-guide/term-references.md
diff --git a/src/components/HomepageFeatures/index.js b/src/components/HomepageFeatures/index.js
@@ -1,32 +1,34 @@
 import clsx from 'clsx';
 import Heading from '@theme/Heading';
 import styles from './styles.module.css';
+import Link from '@docusaurus/Link'; // Import Link component
+
 
 const FeatureList = [
   {
-    title: 'Simple',
+    title: 'Content Authors',
     Svg: require('@site/static/img/specup_logo.svg').default,
     description: (
       <>
-        Only one index.html file. Simple hosting.
+        <Link to="/docs/content-author-guide/introduction">→ Content Authors guide</Link>.
       </>
     ),
   },
   {
-    title: 'User-friendly',
+    title: 'Termsdef Authors',
     Svg: require('@site/static/img/specup_logo.svg').default,
     description: (
       <>
-        Written in markdown.
+        <Link to="/docs/termsdef-author-guide/introduction">→ Termsdef Authors guide</Link>
       </>
     ),
   },
   {
-    title: 'Powered by Node.js',
+    title: 'Curators',
     Svg: require('@site/static/img/specup_logo.svg').default,
     description: (
       <>
-        Spec-Up-T is written in Node.js.
+        <Link to="/docs/curator-guide/introduction">→ Curators Guide</Link>
       </>
     ),
   },