From: Thomas Walker Lynch Date: Fri, 6 Mar 2026 14:21:09 +0000 (+0000) Subject: docs to new style approach X-Git-Url: https://git.reasoningtechnology.com/?a=commitdiff_plain;h=42f2da172a435ffcb6e311f6f240d6575286c0a6;p=RT-style-JS_public docs to new style approach --- diff --git a/administrator/document/00_Project_Structure.html b/administrator/document/00_Project_Structure.html index 61fcd33..b087d29 100644 --- a/administrator/document/00_Project_Structure.html +++ b/administrator/document/00_Project_Structure.html @@ -3,9 +3,7 @@ Project Structure and Ontology - - - + + @@ -33,13 +35,13 @@
  • Write and modify authored/ source.
  • Run builds and stage artifacts in scratchpad/stage.
  • Spot test in experiment/.
    • -
  • Execute the release write script to copy artifacts to user/release for consumption/testing.
    • +
  • Execute the release write script to copy artifacts to consumer/release for consumption/testing.

    • Tester Role

    Responsibilities:

      -
    1. Validate candidates under user/release/.
      2. +
    2. Validate candidates under consumer/release/.
    3. Run regression suites.
    4. Approve for quality and completeness, and create release branches.
    @@ -52,7 +54,7 @@ . setup administrator . setup developer . setup tester -. setup user +. setup consumer

    It is common to have multiple terminal sessions or IDEs open, each running under a different role environment. @@ -60,13 +62,11 @@

    Release Promotion

    - Building and promotion are separate activities. The developer compiles and stages files in developer/scratchpad/stage. The developer then runs release write to transfer those files to user/release. + Building and promotion are separate activities. The developer compiles and stages files in developer/scratchpad/stage. The developer then runs release write to transfer those files to consumer/release.

    - The user/release directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory. + The consumer/release directory is strictly an untracked deployment target. No tools may rebuild during promotion, and no builds are run directly inside the release directory.

    - -     diff --git a/administrator/document/setup.js b/administrator/document/setup.js index 264e6d6..bffdab2 100644 --- a/administrator/document/setup.js +++ b/administrator/document/setup.js @@ -1,5 +1,4 @@ window.RT_REPO_ROOT = "../../"; - document.write(''); document.write(''); document.write(''); diff --git a/developer/document/00_RT_Code_Format.html b/developer/document/00_RT_Code_Format.html index 5813499..1b41ddf 100644 --- a/developer/document/00_RT_Code_Format.html +++ b/developer/document/00_RT_Code_Format.html @@ -3,9 +3,11 @@ RT Prescriptive Code Format Guide - - - + + @@ -90,8 +92,6 @@ if(x == 0) return;
  • Never use tabs.
  • Nest lines under the syntactic element that opened them.
    • - -     diff --git a/developer/document/02_RT_Code_Format.html b/developer/document/02_RT_Code_Format.html index 81e891d..ad5ef8b 100644 --- a/developer/document/02_RT_Code_Format.html +++ b/developer/document/02_RT_Code_Format.html @@ -3,9 +3,11 @@ RT Prescriptive Code Format Guide - - - + + @@ -92,8 +94,6 @@ if(x == 0) return;
  • Never use tabs.
  • Nest lines under the syntactic element that opened them.
    • - -     diff --git a/developer/document/03_Naming_and_Directory_Conventions.html b/developer/document/03_Naming_and_Directory_Conventions.html index a490d83..d34a287 100644 --- a/developer/document/03_Naming_and_Directory_Conventions.html +++ b/developer/document/03_Naming_and_Directory_Conventions.html @@ -3,9 +3,11 @@ Naming and Directory Conventions - - - + + @@ -42,8 +44,6 @@

    The RT C coding environment does not use separate source and header files. Instead, a variable is set that gates off the implementation if the source code is to be used as a header. Hence, all of our C source fits fine within an authored directory.

    - -     diff --git a/developer/document/04_Language_Addenda.html b/developer/document/04_Language_Addenda.html index 4ab0352..d33208e 100644 --- a/developer/document/04_Language_Addenda.html +++ b/developer/document/04_Language_Addenda.html @@ -3,9 +3,11 @@ Language Addenda (C, Python, Bash, Lisp) - - - + + @@ -89,8 +91,6 @@ set -euo pipefail

    When in doubt, start with 02_RT_Code_Format.html for the core rules, then apply the relevant language section here. If a language requires deviation from the generic rules, document that deviation in this file instead of ad-hoc decisions.

    - -     diff --git a/developer/document/setup.js b/developer/document/setup.js new file mode 100644 index 0000000..bffdab2 --- /dev/null +++ b/developer/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../../"; +document.write(''); +document.write(''); +document.write(''); diff --git a/docs.tar b/docs.tar new file mode 100644 index 0000000..dabb4ed Binary files /dev/null and b/docs.tar differ diff --git a/document/setup.js b/document/setup.js new file mode 100644 index 0000000..ca24761 --- /dev/null +++ b/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../"; +document.write(''); +document.write(''); +document.write(''); diff --git a/shared/document/setup.js b/shared/document/setup.js new file mode 100644 index 0000000..bffdab2 --- /dev/null +++ b/shared/document/setup.js @@ -0,0 +1,4 @@ +window.RT_REPO_ROOT = "../../"; +document.write(''); +document.write(''); +document.write('');