We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
specs.json",id:"2-update-specsjson",level:3},{value:"3. Set Up Terms",id:"3-set-up-terms",level:3},{value:"terms-and-definitions-intro.md",id:"terms-and-definitions-intromd",level:4},{value:"4. Update",id:"4-update",level:3},{value:"Completion",id:"completion",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"updating-spec-up-t",children:"Updating Spec-Up-T"})}),"\n",(0,s.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsxs)(n.p,{children:["This guide provides step-by-step instructions to update your ",(0,s.jsx)(n.strong,{children:"Spec-Up-T"})," installation."]}),"\n",(0,s.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,s.jsx)(n.p,{children:"Before proceeding, ensure you have the following tools and knowledge:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Basic familiarity with Git and npm."}),"\n",(0,s.jsx)(n.li,{children:"A text editor (e.g., VS Code or Notepad++)."}),"\n",(0,s.jsx)(n.li,{children:"Installed Node.js and npm."}),"\n",(0,s.jsx)(n.li,{children:"Access to the Spec-Up-T GitHub repository."}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"update",children:"Update"}),"\n",(0,s.jsxs)(n.p,{children:["Updating your ",(0,s.jsx)(n.strong,{children:"Spec-Up-T"})," installation requires the following steps:"]}),"\n",(0,s.jsx)(n.h3,{id:"1-configure-github-token",children:"1. Configure GitHub Token"}),"\n",(0,s.jsxs)(n.p,{children:["You need a GitHub Personal Access Token for authentication. ",(0,s.jsx)(n.a,{href:"/spec-up-t-website/docs/getting-started/github-token",children:"Instructions how to create a GitHub Personal Access Token"}),"."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Rename ",(0,s.jsx)(n.code,{children:".env.example"})," to ",(0,s.jsx)(n.code,{children:".env"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Add your token in the ",(0,s.jsx)(n.code,{children:".env"})," file as follows:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-env",children:"GITHUB_TOKEN=specs.json",id:"2-update-specsjson",level:3},{value:"3. Set Up Terms",id:"3-set-up-terms",level:3},{value:"terms-and-definitions-intro.md",id:"terms-and-definitions-intromd",level:4},{value:"4. Update",id:"4-update",level:3},{value:"Completion",id:"completion",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"updating-spec-up-t",children:"Updating Spec-Up-T"})}),"\n",(0,s.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,s.jsxs)(n.p,{children:["This guide provides step-by-step instructions to update your ",(0,s.jsx)(n.strong,{children:"Spec-Up-T"})," installation."]}),"\n",(0,s.jsx)(n.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,s.jsx)(n.p,{children:"Before proceeding, ensure you have the following tools and knowledge:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Basic familiarity with Git and npm."}),"\n",(0,s.jsx)(n.li,{children:"A text editor (e.g., VS Code or Notepad++)."}),"\n",(0,s.jsx)(n.li,{children:"Installed Node.js and npm."}),"\n",(0,s.jsx)(n.li,{children:"Access to the Spec-Up-T GitHub repository."}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"update",children:"Update"}),"\n",(0,s.jsxs)(n.p,{children:["Updating your ",(0,s.jsx)(n.strong,{children:"Spec-Up-T"})," installation requires the following steps:"]}),"\n",(0,s.jsx)(n.h3,{id:"1-configure-github-token",children:"1. Configure GitHub Token"}),"\n",(0,s.jsxs)(n.p,{children:["You need a GitHub Personal Access Token for authentication. ",(0,s.jsx)(n.a,{href:"/spec-up-t-website/docs/getting-started/github-token",children:"Instructions how to create a GitHub Personal Access Token"}),"."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Rename ",(0,s.jsx)(n.code,{children:".env.example"})," to ",(0,s.jsx)(n.code,{children:".env"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:["Add your token in the ",(0,s.jsx)(n.code,{children:".env"})," file as follows:","\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-env",children:"GITHUB_TOKEN=ref",id:"ref",level:2},{value:"xref",id:"xref",level:2},{value:"tref",id:"tref",level:2}];function a(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"matching-terms",children:"Matching terms"})}),"\n",(0,s.jsx)(t.h2,{id:"intro",children:"Intro"}),"\n",(0,s.jsxs)(t.p,{children:["One of the strengths of Spec-Up-T is that you specify a term, and the link to the definition is automatically established. Both internally (via ",(0,s.jsx)(t.code,{children:"[[ref:term]]"}),") and to external specifications (via ",(0,s.jsx)(t.code,{children:"[[xref:term]]"})," and ",(0,s.jsx)(t.code,{children:"[[tref:term]]"}),")."]}),"\n",(0,s.jsx)(t.p,{children:"This matching occurs in several ways, each with its advantages and disadvantages. Here, we discuss these methods."}),"\n",(0,s.jsx)(t.h2,{id:"ref",children:(0,s.jsx)(t.code,{children:"ref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/markdown-it-extensions.js",children:(0,s.jsx)(t.code,{children:"/src/markdown-it-extensions.js"})}),"."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": the markdown files containing terms and definitions in the exact specification where the ",(0,s.jsx)(t.code,{children:"ref"})," is located."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": Through a custom-written ",(0,s.jsx)(t.code,{children:"markdown-it"})," extension."]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"xref",children:(0,s.jsx)(t.code,{children:"xref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/references.js",children:(0,s.jsx)(t.code,{children:"/src/references.js"})}),"."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": The GitHub page with the external definition."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": Reads HTML via JSDOM and Cross-Origin Resource Sharing (CORS) of the GitHub page."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Downside"}),": You cannot retrieve meta-info like the commit hash, etc. Also, it will no longer work if GitHub makes the CORS policy stricter. GitHub already has some CORS restrictions in place, so further restrictions could be a natural progression."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Upside"}),": easy and fast."]}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"info",children:(0,s.jsx)(t.p,{children:"The JSDOM library brings JavaScript DOM selectors to Node.js."})}),"\n",(0,s.jsx)(t.h2,{id:"tref",children:(0,s.jsx)(t.code,{children:"tref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/collectExternalReferences.js",children:(0,s.jsx)(t.code,{children:"/src/collectExternalReferences.js"})})," and imported modules."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": The markdown files in the external repository."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": It uses the GitHub API / Octokit to search through the remote repository files."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Downside"}),": The API has a limit. Using a Personal Access Token broadens the limit, but it is still a limit."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Upside"}),": it works via an API, An official service created specifically for the purpose for which you use it."]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var i=n(6540);const s={},r=i.createContext(s);function o(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[7622],{4365:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"developer-documentation/matching","title":"Matching terms","description":"Intro","source":"@site/docs/developer-documentation/matching.md","sourceDirName":"developer-documentation","slug":"/developer-documentation/matching","permalink":"/spec-up-t-website/docs/developer-documentation/matching","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/matching.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"tutorialSidebar","previous":{"title":"GitHub Repositories","permalink":"/spec-up-t-website/docs/developer-documentation/github-repositories"},"next":{"title":"Publishing to GitHub and npm","permalink":"/spec-up-t-website/docs/developer-documentation/publishing-to-github-and-npm"}}');var s=n(4848),r=n(8453);const o={sidebar_position:2},c="Matching terms",d={},l=[{value:"Intro",id:"intro",level:2},{value:"ref",id:"ref",level:2},{value:"xref",id:"xref",level:2},{value:"tref",id:"tref",level:2}];function a(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"matching-terms",children:"Matching terms"})}),"\n",(0,s.jsx)(t.h2,{id:"intro",children:"Intro"}),"\n",(0,s.jsxs)(t.p,{children:["One of the strengths of Spec-Up-T is that you specify a term, and the link to the definition is automatically established. Both internally (via ",(0,s.jsx)(t.code,{children:"[[ref:term]]"}),") and to external specifications (via ",(0,s.jsx)(t.code,{children:"[[xref:term]]"})," and ",(0,s.jsx)(t.code,{children:"[[tref:term]]"}),")."]}),"\n",(0,s.jsx)(t.p,{children:"This matching occurs in several ways, each with its advantages and disadvantages. Here, we discuss these methods."}),"\n",(0,s.jsx)(t.h2,{id:"ref",children:(0,s.jsx)(t.code,{children:"ref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/markdown-it-extensions.js",children:(0,s.jsx)(t.code,{children:"/src/markdown-it-extensions.js"})}),"."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": the markdown files containing terms and definitions in the exact specification where the ",(0,s.jsx)(t.code,{children:"ref"})," is located."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": Through a custom-written ",(0,s.jsx)(t.code,{children:"markdown-it"})," extension."]}),"\n"]}),"\n",(0,s.jsx)(t.h2,{id:"xref",children:(0,s.jsx)(t.code,{children:"xref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/references.js",children:(0,s.jsx)(t.code,{children:"/src/references.js"})}),"."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": The GitHub page with the external definition."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": Reads HTML via JSDOM and Cross-Origin Resource Sharing (CORS) of the GitHub page."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Downside"}),": You cannot retrieve meta-info like the commit hash, etc. Also, it will no longer work if GitHub makes the CORS policy stricter. GitHub already has some CORS restrictions in place, so further restrictions could be a natural progression."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Upside"}),": easy and fast."]}),"\n"]}),"\n",(0,s.jsx)(t.admonition,{type:"info",children:(0,s.jsx)(t.p,{children:"The JSDOM library brings JavaScript DOM selectors to Node.js."})}),"\n",(0,s.jsx)(t.h2,{id:"tref",children:(0,s.jsx)(t.code,{children:"tref"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Where"}),": ",(0,s.jsx)(t.a,{href:"https://github.com/trustoverip/spec-up-t/blob/master/src/collectExternalReferences.js",children:(0,s.jsx)(t.code,{children:"/src/collectExternalReferences.js"})})," and imported modules."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Source"}),": The markdown files in the external repository."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"How"}),": It uses the GitHub API / Octokit to search through the remote repository files."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Downside"}),": The API has a limit. Using a Personal Access Token broadens the limit, but it is still a limit."]}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.strong,{children:"Upside"}),": it works via an API, An official service created specifically for the purpose for which you use it."]}),"\n"]})]})}function h(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>o,x:()=>c});var i=n(6540);const s={},r=i.createContext(s);function o(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7616f23a.d08e8f9a.js b/assets/js/7616f23a.b6c072e8.js
similarity index 98%
rename from assets/js/7616f23a.d08e8f9a.js
rename to assets/js/7616f23a.b6c072e8.js
index 030d3e47..5b1c0a7d 100644
--- a/assets/js/7616f23a.d08e8f9a.js
+++ b/assets/js/7616f23a.b6c072e8.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6769],{8453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>a});var n=t(6540);const s={},o=n.createContext(s);function r(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(o.Provider,{value:i},e.children)}},9933:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"introduction/overview","title":"Overview","description":"Spec-Up-T is a technical specification and standardization tool, which a special focus on terminology. It helps you write content in the form of specifications and glossaries.","source":"@site/docs/introduction/overview.md","sourceDirName":"introduction","slug":"/introduction/overview","permalink":"/spec-up-t-website/docs/introduction/overview","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/introduction/overview.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Introduction","permalink":"/spec-up-t-website/docs/category/introduction"},"next":{"title":"Key Features","permalink":"/spec-up-t-website/docs/introduction/key-features"}}');var s=t(4848),o=t(8453);const r={sidebar_position:1},a="Overview",c={},d=[{value:"Difference Between a Glossary and a Specification",id:"difference-between-a-glossary-and-a-specification",level:3},{value:"How They Relate",id:"how-they-relate",level:3}];function l(e){const i={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"overview",children:"Overview"})}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsxs)(i.strong,{children:["Spec-Up-",(0,s.jsx)("span",{className:"rotate",children:"T"})]})," is a technical specification and standardization tool, which a special focus on terminology. It helps you write content in the form of specifications and glossaries."]}),"\n",(0,s.jsx)(i.p,{children:"The two parts content and term definitions also illustrate the two main use cases of Spec-Up-T:"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:"a glossary (fat terms section, slim content section)"}),"\n",(0,s.jsx)(i.li,{children:"a standardization specification (slim terms section, fat content section)"}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsxs)(i.strong,{children:["Spec-Up-",(0,s.jsx)("span",{className:"rotate",children:"T"})]})," is a tool for writing in Markdown files and creates ",(0,s.jsx)(i.em,{children:"one"})," ",(0,s.jsx)(i.code,{children:"index.html"})," file from all these Markdown files."]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["You write your texts in ",(0,s.jsx)(i.a,{href:"https://www.markdownguide.org/getting-started/",children:"Markdown"}),", \u201cthe simple and easy-to-use markup language\u201d"]}),"\n",(0,s.jsx)(i.li,{children:"You use an editor (IDE) or you use GitHub's web editor"}),"\n",(0,s.jsx)(i.li,{children:"The content you write is stored in markdown files on your computer (if you use an IDE) or directly saved to GitHub (if you use GitHub's web editor)"}),"\n",(0,s.jsxs)(i.li,{children:["Your Markdown-files are converted to one ",(0,s.jsx)(i.code,{children:"index.html"})," file"]}),"\n",(0,s.jsxs)(i.li,{children:["The place where your Markdown files and the ",(0,s.jsx)(i.code,{children:"index.html"})," are stored is ",(0,s.jsx)(i.a,{href:"https://github.com",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The endproduct of your work is ",(0,s.jsxs)(i.strong,{children:["the ",(0,s.jsx)(i.code,{children:"index.html"})," file, the actual specification file."]})]}),"\n",(0,s.jsxs)(i.p,{children:["This ",(0,s.jsx)(i.code,{children:"index.html"})," file is stand-alone and can be hosted on any web server. Or double-click it, and it will open in a browser. The most common place is a GitHub Page though."]}),"\n",(0,s.jsxs)(i.p,{children:["The Spec-Up-T code itself is available ",(0,s.jsx)(i.a,{href:"https://github.com/trustoverip/spec-up-t",children:"on Github"}),"."]}),"\n",(0,s.jsxs)(i.admonition,{type:"info",children:[(0,s.jsx)(i.h3,{id:"difference-between-a-glossary-and-a-specification",children:"Difference Between a Glossary and a Specification"}),(0,s.jsxs)(i.p,{children:["A ",(0,s.jsx)(i.strong,{children:"glossary"})," is a collection of terms and their definitions, typically organized alphabetically. It provides clear explanations of key terms, jargon, or acronyms used within a specific context, such as a technical document, project, or industry. The primary purpose of a glossary is to ensure consistency and clarity by offering a shared understanding of terminology."]}),(0,s.jsxs)(i.p,{children:["A ",(0,s.jsx)(i.strong,{children:"standardization specification"}),", on the other hand, is a detailed document that outlines the requirements, standards, or functionality of a system, product, or process. Specifications define what needs to be built, how it should perform, and often include technical details, constraints, and acceptance criteria. Their focus is on actionable details that guide development, testing, and implementation."]}),(0,s.jsx)(i.h3,{id:"how-they-relate",children:"How They Relate"}),(0,s.jsx)(i.p,{children:'A glossary supports a specification by defining the terms used within it, reducing ambiguity and misinterpretation. For example, if a specification uses terms like "API," "latency," or "data integrity," the glossary provides precise definitions to ensure all stakeholders understand these terms uniformly. In this way, a glossary complements the specification, serving as a foundational reference to enhance its clarity and usability.'}),(0,s.jsxs)(i.p,{children:["An example ",(0,s.jsx)(i.strong,{children:"glossary"})," is the ",(0,s.jsx)(i.a,{href:"https://github.com/trustoverip/ctwg-main-glossary",children:"Main TrustoverIP glossary"})]}),(0,s.jsxs)(i.p,{children:["An example ",(0,s.jsx)(i.strong,{children:"standardization specification"})," is the ",(0,s.jsxs)(i.a,{href:"https://github.com/trustoverip/tswg-did-method-webs-specification",children:["DID",":Webs"," specification"]})]})]})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6769],{8453:(e,i,t)=>{t.d(i,{R:()=>r,x:()=>a});var n=t(6540);const s={},o=n.createContext(s);function r(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function a(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),n.createElement(o.Provider,{value:i},e.children)}},9933:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>r,metadata:()=>n,toc:()=>d});const n=JSON.parse('{"id":"introduction/overview","title":"Overview","description":"Spec-Up-T is a technical specification and standardization tool, which a special focus on terminology. It helps you write content in the form of specifications and glossaries.","source":"@site/docs/introduction/overview.md","sourceDirName":"introduction","slug":"/introduction/overview","permalink":"/spec-up-t-website/docs/introduction/overview","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/introduction/overview.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Introduction","permalink":"/spec-up-t-website/docs/category/introduction"},"next":{"title":"Key Features","permalink":"/spec-up-t-website/docs/introduction/key-features"}}');var s=t(4848),o=t(8453);const r={sidebar_position:1},a="Overview",c={},d=[{value:"Difference Between a Glossary and a Specification",id:"difference-between-a-glossary-and-a-specification",level:3},{value:"How They Relate",id:"how-they-relate",level:3}];function l(e){const i={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"overview",children:"Overview"})}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsxs)(i.strong,{children:["Spec-Up-",(0,s.jsx)("span",{className:"rotate",children:"T"})]})," is a technical specification and standardization tool, which a special focus on terminology. It helps you write content in the form of specifications and glossaries."]}),"\n",(0,s.jsx)(i.p,{children:"The two parts content and term definitions also illustrate the two main use cases of Spec-Up-T:"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsx)(i.li,{children:"a glossary (fat terms section, slim content section)"}),"\n",(0,s.jsx)(i.li,{children:"a standardization specification (slim terms section, fat content section)"}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:[(0,s.jsxs)(i.strong,{children:["Spec-Up-",(0,s.jsx)("span",{className:"rotate",children:"T"})]})," is a tool for writing in Markdown files and creates ",(0,s.jsx)(i.em,{children:"one"})," ",(0,s.jsx)(i.code,{children:"index.html"})," file from all these Markdown files."]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["You write your texts in ",(0,s.jsx)(i.a,{href:"https://www.markdownguide.org/getting-started/",children:"Markdown"}),", \u201cthe simple and easy-to-use markup language\u201d"]}),"\n",(0,s.jsx)(i.li,{children:"You use an editor (IDE) or you use GitHub's web editor"}),"\n",(0,s.jsx)(i.li,{children:"The content you write is stored in markdown files on your computer (if you use an IDE) or directly saved to GitHub (if you use GitHub's web editor)"}),"\n",(0,s.jsxs)(i.li,{children:["Your Markdown-files are converted to one ",(0,s.jsx)(i.code,{children:"index.html"})," file"]}),"\n",(0,s.jsxs)(i.li,{children:["The place where your Markdown files and the ",(0,s.jsx)(i.code,{children:"index.html"})," are stored is ",(0,s.jsx)(i.a,{href:"https://github.com",children:"GitHub"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The endproduct of your work is ",(0,s.jsxs)(i.strong,{children:["the ",(0,s.jsx)(i.code,{children:"index.html"})," file, the actual specification file."]})]}),"\n",(0,s.jsxs)(i.p,{children:["This ",(0,s.jsx)(i.code,{children:"index.html"})," file is stand-alone and can be hosted on any web server. Or double-click it, and it will open in a browser. The most common place is a GitHub Page though."]}),"\n",(0,s.jsxs)(i.p,{children:["The Spec-Up-T code itself is available ",(0,s.jsx)(i.a,{href:"https://github.com/trustoverip/spec-up-t",children:"on Github"}),"."]}),"\n",(0,s.jsxs)(i.admonition,{type:"info",children:[(0,s.jsx)(i.h3,{id:"difference-between-a-glossary-and-a-specification",children:"Difference Between a Glossary and a Specification"}),(0,s.jsxs)(i.p,{children:["A ",(0,s.jsx)(i.strong,{children:"glossary"})," is a collection of terms and their definitions, typically organized alphabetically. It provides clear explanations of key terms, jargon, or acronyms used within a specific context, such as a technical document, project, or industry. The primary purpose of a glossary is to ensure consistency and clarity by offering a shared understanding of terminology."]}),(0,s.jsxs)(i.p,{children:["A ",(0,s.jsx)(i.strong,{children:"standardization specification"}),", on the other hand, is a detailed document that outlines the requirements, standards, or functionality of a system, product, or process. Specifications define what needs to be built, how it should perform, and often include technical details, constraints, and acceptance criteria. Their focus is on actionable details that guide development, testing, and implementation."]}),(0,s.jsx)(i.h3,{id:"how-they-relate",children:"How They Relate"}),(0,s.jsx)(i.p,{children:'A glossary supports a specification by defining the terms used within it, reducing ambiguity and misinterpretation. For example, if a specification uses terms like "API," "latency," or "data integrity," the glossary provides precise definitions to ensure all stakeholders understand these terms uniformly. In this way, a glossary complements the specification, serving as a foundational reference to enhance its clarity and usability.'}),(0,s.jsxs)(i.p,{children:["An example ",(0,s.jsx)(i.strong,{children:"glossary"})," is the ",(0,s.jsx)(i.a,{href:"https://github.com/trustoverip/ctwg-main-glossary",children:"Main TrustoverIP glossary"})]}),(0,s.jsxs)(i.p,{children:["An example ",(0,s.jsx)(i.strong,{children:"standardization specification"})," is the ",(0,s.jsxs)(i.a,{href:"https://github.com/trustoverip/tswg-did-method-webs-specification",children:["DID",":Webs"," specification"]})]})]})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}}}]);
\ No newline at end of file
diff --git a/assets/js/79b3c53f.c5f38456.js b/assets/js/79b3c53f.f0e1d21e.js
similarity index 99%
rename from assets/js/79b3c53f.c5f38456.js
rename to assets/js/79b3c53f.f0e1d21e.js
index 137d62c3..203f76df 100644
--- a/assets/js/79b3c53f.c5f38456.js
+++ b/assets/js/79b3c53f.f0e1d21e.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8837],{7517:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"getting-started/web-based/running-the-menu-workflow","title":"Menu Workflow","description":"Running the \\"Menu\\" Workflow","source":"@site/docs/getting-started/web-based/running-the-menu-workflow.md","sourceDirName":"getting-started/web-based","slug":"/getting-started/web-based/running-the-menu-workflow","permalink":"/spec-up-t-website/docs/getting-started/web-based/running-the-menu-workflow","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/getting-started/web-based/running-the-menu-workflow.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Create a New Installation","permalink":"/spec-up-t-website/docs/getting-started/web-based/create-new-spec-up-t-installation"},"next":{"title":"Local Installation","permalink":"/spec-up-t-website/docs/category/local-installation"}}');var r=s(4848),i=s(8453);const o={sidebar_position:3},l="Menu Workflow",c={},d=[{value:"Running the "Menu" Workflow",id:"running-the-menu-workflow",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Steps to Run the Workflow",id:"steps-to-run-the-workflow",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Example",id:"example",level:3}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"menu-workflow",children:"Menu Workflow"})}),"\n",(0,r.jsx)(n.h2,{id:"running-the-menu-workflow",children:'Running the "Menu" Workflow'}),"\n",(0,r.jsxs)(n.p,{children:['This guide shows you how to use the "Menu" workflow in the ',(0,r.jsx)(n.code,{children:"trustoverip/spec-up-t"})," repository to run various Spec-Up-T scripts directly from your browser\u2014no local setup needed! Whether you want to render a specification, update files, or generate a PDF, this workflow has you covered."]}),"\n",(0,r.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'A GitHub account with access to the repository where this workflow runs (e.g., a repo created by the "Create Spec-Up-T Project via Repo Creation" workflow).'}),"\n",(0,r.jsxs)(n.li,{children:["The repository must have a ",(0,r.jsx)(n.code,{children:"MY_PAT"})," secret set up with ",(0,r.jsx)(n.code,{children:"repo"})," and ",(0,r.jsx)(n.code,{children:"workflow"}),' scopes (automatically added if created via the "Create Spec-Up-T Project" workflow).']}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"steps-to-run-the-workflow",children:"Steps to Run the Workflow"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Navigate to the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Go to the ",(0,r.jsx)(n.a,{href:"https://github.com/kordwarshuis/myproject4/actions",children:"Actions tab"})," in your project repository (e.g., ",(0,r.jsx)(n.code,{children:"your-username/my-spec-project"}),")."]}),"\n",(0,r.jsxs)(n.li,{children:["Scroll through the list of workflows on the left and find ",(0,r.jsx)(n.strong,{children:'"Menu"'}),". Click it to select it."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Start the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'On the right side, click the "Run workflow" button or dropdown (it might be a button or under a small arrow). A form will appear with a dropdown menu.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Select a Script"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Select the script to run"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Use the dropdown to choose one of the following options:","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Render specification"}),": Renders your specification to ",(0,r.jsx)(n.code,{children:"index.html"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Collect external references (cached)"}),": Gathers external references using a cache (will fetch cache the first time you run it)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Collect external references (no cache)"}),": Gathers external references without caching, using ",(0,r.jsx)(n.code,{children:"MY_PAT"})," for authentication"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Convert to PDF"}),": Generates a PDF from your specification"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Freeze specification"}),": Freezes the specification state"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"List references"}),": Lists all references in the specification"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom update"}),": Updates your installation"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.li,{children:'Default: "Render specification"'}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.li,{children:'Click the green "Run workflow" button at the bottom of the form.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Monitor the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'You\u2019ll return to the Actions page, where a new run appears under "Menu" with a yellow circle (running) or green check (completed).'}),"\n",(0,r.jsx)(n.li,{children:"Wait a minute or two (refresh if needed) for it to finish."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Check the Results"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For Most Options (e.g., "Render specification", "Convert to PDF")'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["If successful (green check), the output is deployed to the ",(0,r.jsx)(n.code,{children:"gh-pages"})," branch."]}),"\n",(0,r.jsxs)(n.li,{children:["Visit your GitHub Pages site (e.g., ",(0,r.jsx)(n.code,{children:"https://your-username.github.io/my-spec-project"}),') to see the result (after running "Set GitHub Pages and Homepage" if not yet set).']}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For "Custom update"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Changes are committed to your repository\u2019s ",(0,r.jsx)(n.code,{children:"main"})," branch."]}),"\n",(0,r.jsxs)(n.li,{children:["Check the repo\u2019s commit history (e.g., ",(0,r.jsx)(n.code,{children:"https://github.com/your-username/my-spec-project/commits/main"}),') for a commit like "Custom update: Copy files from spec-up-t".']}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For "Show help" or "Show menu"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Output appears in the workflow logs\u2014no deployment occurs."}),"\n",(0,r.jsx)(n.li,{children:'Click the run, expand "Run selected script," and read the text output.'}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Run Fails (Red X)"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:['Click the run, expand steps (e.g., "Run selected script"), and check for errors (e.g., missing ',(0,r.jsx)(n.code,{children:"MY_PAT"}),", file not found)."]}),"\n",(0,r.jsxs)(n.li,{children:["Ensure ",(0,r.jsx)(n.code,{children:"MY_PAT"})," is in your repo\u2019s secrets (",(0,r.jsx)(n.code,{children:"Settings > Secrets and variables > Actions"}),")."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"No Pages Update"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'Verify "Set GitHub Pages and Homepage" has run to configure Pages.'}),"\n",(0,r.jsxs)(n.li,{children:["Check ",(0,r.jsx)(n.code,{children:"gh-pages"})," branch for updated files."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'No Commits from "Custom update"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Ensure ",(0,r.jsx)(n.code,{children:"custom-update.js"})," modifies files\u2014empty changes won\u2019t commit."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"To render a specification:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'Select: "Render specification"'}),"\n",(0,r.jsxs)(n.li,{children:["Result: Files deploy to ",(0,r.jsx)(n.code,{children:"gh-pages"}),", viewable at your Pages URL."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Enjoy exploring Spec-Up-T\u2014happy scripting!"})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>l});var t=s(6540);const r={},i=t.createContext(r);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8837],{7517:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>o,metadata:()=>t,toc:()=>d});const t=JSON.parse('{"id":"getting-started/web-based/running-the-menu-workflow","title":"Menu Workflow","description":"Running the \\"Menu\\" Workflow","source":"@site/docs/getting-started/web-based/running-the-menu-workflow.md","sourceDirName":"getting-started/web-based","slug":"/getting-started/web-based/running-the-menu-workflow","permalink":"/spec-up-t-website/docs/getting-started/web-based/running-the-menu-workflow","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/getting-started/web-based/running-the-menu-workflow.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Create a New Installation","permalink":"/spec-up-t-website/docs/getting-started/web-based/create-new-spec-up-t-installation"},"next":{"title":"Local Installation","permalink":"/spec-up-t-website/docs/category/local-installation"}}');var r=s(4848),i=s(8453);const o={sidebar_position:3},l="Menu Workflow",c={},d=[{value:"Running the "Menu" Workflow",id:"running-the-menu-workflow",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Steps to Run the Workflow",id:"steps-to-run-the-workflow",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Example",id:"example",level:3}];function h(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"menu-workflow",children:"Menu Workflow"})}),"\n",(0,r.jsx)(n.h2,{id:"running-the-menu-workflow",children:'Running the "Menu" Workflow'}),"\n",(0,r.jsxs)(n.p,{children:['This guide shows you how to use the "Menu" workflow in the ',(0,r.jsx)(n.code,{children:"trustoverip/spec-up-t"})," repository to run various Spec-Up-T scripts directly from your browser\u2014no local setup needed! Whether you want to render a specification, update files, or generate a PDF, this workflow has you covered."]}),"\n",(0,r.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'A GitHub account with access to the repository where this workflow runs (e.g., a repo created by the "Create Spec-Up-T Project via Repo Creation" workflow).'}),"\n",(0,r.jsxs)(n.li,{children:["The repository must have a ",(0,r.jsx)(n.code,{children:"MY_PAT"})," secret set up with ",(0,r.jsx)(n.code,{children:"repo"})," and ",(0,r.jsx)(n.code,{children:"workflow"}),' scopes (automatically added if created via the "Create Spec-Up-T Project" workflow).']}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"steps-to-run-the-workflow",children:"Steps to Run the Workflow"}),"\n",(0,r.jsxs)(n.ol,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Navigate to the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Go to the ",(0,r.jsx)(n.a,{href:"https://github.com/kordwarshuis/myproject4/actions",children:"Actions tab"})," in your project repository (e.g., ",(0,r.jsx)(n.code,{children:"your-username/my-spec-project"}),")."]}),"\n",(0,r.jsxs)(n.li,{children:["Scroll through the list of workflows on the left and find ",(0,r.jsx)(n.strong,{children:'"Menu"'}),". Click it to select it."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Start the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'On the right side, click the "Run workflow" button or dropdown (it might be a button or under a small arrow). A form will appear with a dropdown menu.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Select a Script"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Select the script to run"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Use the dropdown to choose one of the following options:","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Render specification"}),": Renders your specification to ",(0,r.jsx)(n.code,{children:"index.html"})]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Collect external references (cached)"}),": Gathers external references using a cache (will fetch cache the first time you run it)"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Collect external references (no cache)"}),": Gathers external references without caching, using ",(0,r.jsx)(n.code,{children:"MY_PAT"})," for authentication"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Convert to PDF"}),": Generates a PDF from your specification"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Freeze specification"}),": Freezes the specification state"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"List references"}),": Lists all references in the specification"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Custom update"}),": Updates your installation"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.li,{children:'Default: "Render specification"'}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.li,{children:'Click the green "Run workflow" button at the bottom of the form.'}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Monitor the Workflow"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'You\u2019ll return to the Actions page, where a new run appears under "Menu" with a yellow circle (running) or green check (completed).'}),"\n",(0,r.jsx)(n.li,{children:"Wait a minute or two (refresh if needed) for it to finish."}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Check the Results"}),":"]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For Most Options (e.g., "Render specification", "Convert to PDF")'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["If successful (green check), the output is deployed to the ",(0,r.jsx)(n.code,{children:"gh-pages"})," branch."]}),"\n",(0,r.jsxs)(n.li,{children:["Visit your GitHub Pages site (e.g., ",(0,r.jsx)(n.code,{children:"https://your-username.github.io/my-spec-project"}),') to see the result (after running "Set GitHub Pages and Homepage" if not yet set).']}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For "Custom update"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Changes are committed to your repository\u2019s ",(0,r.jsx)(n.code,{children:"main"})," branch."]}),"\n",(0,r.jsxs)(n.li,{children:["Check the repo\u2019s commit history (e.g., ",(0,r.jsx)(n.code,{children:"https://github.com/your-username/my-spec-project/commits/main"}),') for a commit like "Custom update: Copy files from spec-up-t".']}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'For "Show help" or "Show menu"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Output appears in the workflow logs\u2014no deployment occurs."}),"\n",(0,r.jsx)(n.li,{children:'Click the run, expand "Run selected script," and read the text output.'}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"Run Fails (Red X)"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:['Click the run, expand steps (e.g., "Run selected script"), and check for errors (e.g., missing ',(0,r.jsx)(n.code,{children:"MY_PAT"}),", file not found)."]}),"\n",(0,r.jsxs)(n.li,{children:["Ensure ",(0,r.jsx)(n.code,{children:"MY_PAT"})," is in your repo\u2019s secrets (",(0,r.jsx)(n.code,{children:"Settings > Secrets and variables > Actions"}),")."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"No Pages Update"}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'Verify "Set GitHub Pages and Homepage" has run to configure Pages.'}),"\n",(0,r.jsxs)(n.li,{children:["Check ",(0,r.jsx)(n.code,{children:"gh-pages"})," branch for updated files."]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:'No Commits from "Custom update"'}),":","\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["Ensure ",(0,r.jsx)(n.code,{children:"custom-update.js"})," modifies files\u2014empty changes won\u2019t commit."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.p,{children:"To render a specification:"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:'Select: "Render specification"'}),"\n",(0,r.jsxs)(n.li,{children:["Result: Files deploy to ",(0,r.jsx)(n.code,{children:"gh-pages"}),", viewable at your Pages URL."]}),"\n"]}),"\n",(0,r.jsx)(n.p,{children:"Enjoy exploring Spec-Up-T\u2014happy scripting!"})]})}function a(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>l});var t=s(6540);const r={},i=t.createContext(r);function o(e){const n=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(i.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/7e7aa536.4bb68076.js b/assets/js/7e7aa536.615f6aa3.js
similarity index 99%
rename from assets/js/7e7aa536.4bb68076.js
rename to assets/js/7e7aa536.615f6aa3.js
index d2cda54b..354379ad 100644
--- a/assets/js/7e7aa536.4bb68076.js
+++ b/assets/js/7e7aa536.615f6aa3.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[130],{7178:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a simple tool designed to facilitate the creation, management, and rendering of technical specifications. Users who intend to leverage Spec-Up-T for their projects must possess this technical knowledge:","source":"@site/docs/various-roles/technical-skills-needed.md","sourceDirName":"various-roles","slug":"/various-roles/technical-skills-needed","permalink":"/spec-up-t-website/docs/various-roles/technical-skills-needed","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/technical-skills-needed.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":20,"frontMatter":{"sidebar_position":20},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/various-roles/readers-guide/introduction"},"next":{"title":"Advanced Features","permalink":"/spec-up-t-website/docs/category/advanced-features"}}');var t=i(4848),o=i(8453);const r={sidebar_position:20},d="Technical skills needed",l={},a=[{value:"1",id:"1",level:2},{value:"Node.js and npm",id:"nodejs-and-npm",level:3},{value:"2",id:"2",level:2},{value:"File System Navigation and Directory Management",id:"file-system-navigation-and-directory-management",level:3},{value:"3",id:"3",level:2},{value:"JSON Configuration Files",id:"json-configuration-files",level:3},{value:"4",id:"4",level:2},{value:"Markdown Language",id:"markdown-language",level:3},{value:"5",id:"5",level:2},{value:"Web Development",id:"web-development",level:3},{value:"6",id:"6",level:2},{value:"GitHub Version Control and GitHub Actions Automation",id:"github-version-control-and-github-actions-automation",level:3},{value:"7",id:"7",level:2},{value:"Debugging and Development Tools",id:"debugging-and-development-tools",level:3},{value:"Summary",id:"summary",level:2}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"technical-skills-needed",children:"Technical skills needed"})}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T is a simple tool designed to facilitate the creation, management, and rendering of technical specifications. Users who intend to leverage Spec-Up-T for their projects must possess this technical knowledge:\nInstallation, configuration, and utilization of this tool.\nThis article delves into the technical prerequisites necessary to operate Spec-Up-T competently."}),"\n",(0,t.jsx)(n.p,{children:"Each type of user needs only some of the knowledge described here. We distinguish different roles."}),"\n",(0,t.jsx)(n.h2,{id:"1",children:"1"}),"\n",(0,t.jsx)(n.h3,{id:"nodejs-and-npm",children:"Node.js and npm"}),"\n",(0,t.jsxs)(n.p,{children:["At the core of Spec-Up-T's installation and operation lies the ",(0,t.jsx)(n.a,{href:"https://nodejs.org/en",children:"Node.js"})," environment, coupled with ",(0,t.jsx)(n.a,{href:"https://www.npmjs.com/",children:"npm (Node Package Manager)"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Installation and Setup:"})," Download and install Node.js, and set up all relevant dependencies correctly."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Command-Line Interface (CLI) Proficiency:"})," Operations, including installing Spec-Up-T, running npm commands, and managing directories, are executed via terminal commands."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Understanding npm Scripts:"})," Think of ",(0,t.jsx)(n.code,{children:"npm run install"}),", ",(0,t.jsx)(n.code,{children:"npm run render"}),", and ",(0,t.jsx)(n.code,{children:"npm run dev"}),". These scripts automate various tasks in Spec-Up-T, from installing dependencies to rendering the final HTML output."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"2",children:"2"}),"\n",(0,t.jsx)(n.h3,{id:"file-system-navigation-and-directory-management",children:"File System Navigation and Directory Management"}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T users need to navigate through the file system, create and manage directories, and understand relative paths. These tasks are fundamental to setting up and maintaining a Spec-Up-T project."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Know how to move between directories using the command line. (",(0,t.jsx)(n.code,{children:"cd"})," command) and create directories (",(0,t.jsx)(n.code,{children:"mkdir"}),")."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"3",children:"3"}),"\n",(0,t.jsx)(n.h3,{id:"json-configuration-files",children:"JSON Configuration Files"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"specs.json"})," file plays a key role in Spec-Up-T, as it contains configuration details that dictate how the tool generates and outputs the specification documents. It's JSON (JavaScript Object Notation) format; it's a lightweight data-interchange format that is doable for humans to read and write."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Editing JSON Files:"})," Be able to open, read, and edit JSON files to customize their Spec-Up-T setup."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Understanding JSON Structure:"})," A basic understanding of JSON structure\u2014such as key-value pairs, arrays, and nested objects\u2014is necessary to effectively modify the ",(0,t.jsx)(n.code,{children:"specs.json"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"4",children:"4"}),"\n",(0,t.jsx)(n.h3,{id:"markdown-language",children:"Markdown Language"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.\nRead more about ",(0,t.jsx)(n.a,{href:"https://www.markdownguide.org/getting-started/",children:"Markdown"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Markdown Syntax:"})," Be comfortable with Markdown syntax, including headers, lists, links, and code blocks. Structure the content of your specification clearly and concisely."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"5",children:"5"}),"\n",(0,t.jsx)(n.h3,{id:"web-development",children:"Web Development"}),"\n",(0,t.jsx)(n.p,{children:"Since Spec-Up-T ultimately renders an HTML file that is intended for web viewing, a foundational understanding of web development is beneficial."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Browser Usage:"})," Use a web browser to open the ",(0,t.jsx)(n.code,{children:"index.html"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"6",children:"6"}),"\n",(0,t.jsx)(n.h3,{id:"github-version-control-and-github-actions-automation",children:"GitHub Version Control and GitHub Actions Automation"}),"\n",(0,t.jsx)(n.p,{children:"Automate the rendering and deployment of your specifications."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Basic Git Operations:"})," Understand how to commit changes, push them to a remote repository, and manage branches within a Git version control system. This is crucial for maintaining a history of changes and collaborating with others. Offering a PR is another skill you need to possess."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"GitHub Actions:"})," GitHub Actions or similar CI/CD (Continuous Integration/Continuous Deployment) automates the rendering process. Set up workflows that trigger rendering and deployment automatically upon certain events, such as commits or pull requests (PRs)."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"7",children:"7"}),"\n",(0,t.jsx)(n.h3,{id:"debugging-and-development-tools",children:"Debugging and Development Tools"}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T provides different modes for rendering specifications, including a development mode that enables debugging features."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsxs)(n.strong,{children:["Using ",(0,t.jsx)(n.code,{children:"npm run dev"}),":"]})," Users should be familiar with development workflows, where the ",(0,t.jsx)(n.code,{children:"npm run dev"})," command allows them to test and debug their specifications before finalizing them."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Debugging Techniques:"})," Basic debugging techniques, such as checking for errors in the terminal output and using browser developer tools to inspect rendered HTML, can be very helpful in troubleshooting issues with the specification files."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"summary",children:"Summary"}),"\n",(0,t.jsx)(n.p,{children:"Operating Spec-Up-T requires a blend of technical skills across several domains, including Node.js and npm, file system management, JSON configuration, Markdown proficiency, web development, version control, and debugging. Users with a solid understanding of these areas can use Spec-Up-T fully. Once installed and configured, you can structure your technical specifications, including your terminology, well for your projects."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var s=i(6540);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[130],{7178:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a simple tool designed to facilitate the creation, management, and rendering of technical specifications. Users who intend to leverage Spec-Up-T for their projects must possess this technical knowledge:","source":"@site/docs/various-roles/technical-skills-needed.md","sourceDirName":"various-roles","slug":"/various-roles/technical-skills-needed","permalink":"/spec-up-t-website/docs/various-roles/technical-skills-needed","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/technical-skills-needed.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":20,"frontMatter":{"sidebar_position":20},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/various-roles/readers-guide/introduction"},"next":{"title":"Advanced Features","permalink":"/spec-up-t-website/docs/category/advanced-features"}}');var t=i(4848),o=i(8453);const r={sidebar_position:20},d="Technical skills needed",l={},a=[{value:"1",id:"1",level:2},{value:"Node.js and npm",id:"nodejs-and-npm",level:3},{value:"2",id:"2",level:2},{value:"File System Navigation and Directory Management",id:"file-system-navigation-and-directory-management",level:3},{value:"3",id:"3",level:2},{value:"JSON Configuration Files",id:"json-configuration-files",level:3},{value:"4",id:"4",level:2},{value:"Markdown Language",id:"markdown-language",level:3},{value:"5",id:"5",level:2},{value:"Web Development",id:"web-development",level:3},{value:"6",id:"6",level:2},{value:"GitHub Version Control and GitHub Actions Automation",id:"github-version-control-and-github-actions-automation",level:3},{value:"7",id:"7",level:2},{value:"Debugging and Development Tools",id:"debugging-and-development-tools",level:3},{value:"Summary",id:"summary",level:2}];function c(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"technical-skills-needed",children:"Technical skills needed"})}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T is a simple tool designed to facilitate the creation, management, and rendering of technical specifications. Users who intend to leverage Spec-Up-T for their projects must possess this technical knowledge:\nInstallation, configuration, and utilization of this tool.\nThis article delves into the technical prerequisites necessary to operate Spec-Up-T competently."}),"\n",(0,t.jsx)(n.p,{children:"Each type of user needs only some of the knowledge described here. We distinguish different roles."}),"\n",(0,t.jsx)(n.h2,{id:"1",children:"1"}),"\n",(0,t.jsx)(n.h3,{id:"nodejs-and-npm",children:"Node.js and npm"}),"\n",(0,t.jsxs)(n.p,{children:["At the core of Spec-Up-T's installation and operation lies the ",(0,t.jsx)(n.a,{href:"https://nodejs.org/en",children:"Node.js"})," environment, coupled with ",(0,t.jsx)(n.a,{href:"https://www.npmjs.com/",children:"npm (Node Package Manager)"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Installation and Setup:"})," Download and install Node.js, and set up all relevant dependencies correctly."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Command-Line Interface (CLI) Proficiency:"})," Operations, including installing Spec-Up-T, running npm commands, and managing directories, are executed via terminal commands."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Understanding npm Scripts:"})," Think of ",(0,t.jsx)(n.code,{children:"npm run install"}),", ",(0,t.jsx)(n.code,{children:"npm run render"}),", and ",(0,t.jsx)(n.code,{children:"npm run dev"}),". These scripts automate various tasks in Spec-Up-T, from installing dependencies to rendering the final HTML output."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"2",children:"2"}),"\n",(0,t.jsx)(n.h3,{id:"file-system-navigation-and-directory-management",children:"File System Navigation and Directory Management"}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T users need to navigate through the file system, create and manage directories, and understand relative paths. These tasks are fundamental to setting up and maintaining a Spec-Up-T project."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Know how to move between directories using the command line. (",(0,t.jsx)(n.code,{children:"cd"})," command) and create directories (",(0,t.jsx)(n.code,{children:"mkdir"}),")."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"3",children:"3"}),"\n",(0,t.jsx)(n.h3,{id:"json-configuration-files",children:"JSON Configuration Files"}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"specs.json"})," file plays a key role in Spec-Up-T, as it contains configuration details that dictate how the tool generates and outputs the specification documents. It's JSON (JavaScript Object Notation) format; it's a lightweight data-interchange format that is doable for humans to read and write."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Editing JSON Files:"})," Be able to open, read, and edit JSON files to customize their Spec-Up-T setup."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Understanding JSON Structure:"})," A basic understanding of JSON structure\u2014such as key-value pairs, arrays, and nested objects\u2014is necessary to effectively modify the ",(0,t.jsx)(n.code,{children:"specs.json"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"4",children:"4"}),"\n",(0,t.jsx)(n.h3,{id:"markdown-language",children:"Markdown Language"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:["Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.\nRead more about ",(0,t.jsx)(n.a,{href:"https://www.markdownguide.org/getting-started/",children:"Markdown"})]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Markdown Syntax:"})," Be comfortable with Markdown syntax, including headers, lists, links, and code blocks. Structure the content of your specification clearly and concisely."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"5",children:"5"}),"\n",(0,t.jsx)(n.h3,{id:"web-development",children:"Web Development"}),"\n",(0,t.jsx)(n.p,{children:"Since Spec-Up-T ultimately renders an HTML file that is intended for web viewing, a foundational understanding of web development is beneficial."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Browser Usage:"})," Use a web browser to open the ",(0,t.jsx)(n.code,{children:"index.html"})," file."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"6",children:"6"}),"\n",(0,t.jsx)(n.h3,{id:"github-version-control-and-github-actions-automation",children:"GitHub Version Control and GitHub Actions Automation"}),"\n",(0,t.jsx)(n.p,{children:"Automate the rendering and deployment of your specifications."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Basic Git Operations:"})," Understand how to commit changes, push them to a remote repository, and manage branches within a Git version control system. This is crucial for maintaining a history of changes and collaborating with others. Offering a PR is another skill you need to possess."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"GitHub Actions:"})," GitHub Actions or similar CI/CD (Continuous Integration/Continuous Deployment) automates the rendering process. Set up workflows that trigger rendering and deployment automatically upon certain events, such as commits or pull requests (PRs)."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"7",children:"7"}),"\n",(0,t.jsx)(n.h3,{id:"debugging-and-development-tools",children:"Debugging and Development Tools"}),"\n",(0,t.jsx)(n.p,{children:"Spec-Up-T provides different modes for rendering specifications, including a development mode that enables debugging features."}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.strong,{children:"Required Knowledge:"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsxs)(n.strong,{children:["Using ",(0,t.jsx)(n.code,{children:"npm run dev"}),":"]})," Users should be familiar with development workflows, where the ",(0,t.jsx)(n.code,{children:"npm run dev"})," command allows them to test and debug their specifications before finalizing them."]}),"\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.strong,{children:"Debugging Techniques:"})," Basic debugging techniques, such as checking for errors in the terminal output and using browser developer tools to inspect rendered HTML, can be very helpful in troubleshooting issues with the specification files."]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"summary",children:"Summary"}),"\n",(0,t.jsx)(n.p,{children:"Operating Spec-Up-T requires a blend of technical skills across several domains, including Node.js and npm, file system management, JSON configuration, Markdown proficiency, web development, version control, and debugging. Users with a solid understanding of these areas can use Spec-Up-T fully. Once installed and configured, you can structure your technical specifications, including your terminology, well for your projects."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>d});var s=i(6540);const t={},o=s.createContext(t);function r(e){const n=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),s.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/810fce0e.3856bc99.js b/assets/js/810fce0e.84ad3385.js
similarity index 99%
rename from assets/js/810fce0e.3856bc99.js
rename to assets/js/810fce0e.84ad3385.js
index 0648230b..725b3f34 100644
--- a/assets/js/810fce0e.3856bc99.js
+++ b/assets/js/810fce0e.84ad3385.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9729],{4247:(e,i,t)=>{t.d(i,{A:()=>n});const n="data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iOTgiIGhlaWdodD0iOTYiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik00OC44NTQgMEMyMS44MzkgMCAwIDIyIDAgNDkuMjE3YzAgMjEuNzU2IDEzLjk5MyA0MC4xNzIgMzMuNDA1IDQ2LjY5IDIuNDI3LjQ5IDMuMzE2LTEuMDU5IDMuMzE2LTIuMzYyIDAtMS4xNDEtLjA4LTUuMDUyLS4wOC05LjEyNy0xMy41OSAyLjkzNC0xNi40Mi01Ljg2Ny0xNi40Mi01Ljg2Ny0yLjE4NC01LjcwNC01LjQyLTcuMTctNS40Mi03LjE3LTQuNDQ4LTMuMDE1LjMyNC0zLjAxNS4zMjQtMy4wMTUgNC45MzQuMzI2IDcuNTIzIDUuMDUyIDcuNTIzIDUuMDUyIDQuMzY3IDcuNDk2IDExLjQwNCA1LjM3OCAxNC4yMzUgNC4wNzQuNDA0LTMuMTc4IDEuNjk5LTUuMzc4IDMuMDc0LTYuNi0xMC44MzktMS4xNDEtMjIuMjQzLTUuMzc4LTIyLjI0My0yNC4yODMgMC01LjM3OCAxLjk0LTkuNzc4IDUuMDE0LTEzLjItLjQ4NS0xLjIyMi0yLjE4NC02LjI3NS40ODYtMTMuMDM4IDAgMCA0LjEyNS0xLjMwNCAxMy40MjYgNS4wNTJhNDYuOTcgNDYuOTcgMCAwIDEgMTIuMjE0LTEuNjNjNC4xMjUgMCA4LjMzLjU3MSAxMi4yMTMgMS42MyA5LjMwMi02LjM1NiAxMy40MjctNS4wNTIgMTMuNDI3LTUuMDUyIDIuNjcgNi43NjMuOTcgMTEuODE2LjQ4NSAxMy4wMzggMy4xNTUgMy40MjIgNS4wMTUgNy44MjIgNS4wMTUgMTMuMiAwIDE4LjkwNS0xMS40MDQgMjMuMDYtMjIuMzI0IDI0LjI4MyAxLjc4IDEuNTQ4IDMuMzE2IDQuNDgxIDMuMzE2IDkuMTI2IDAgNi42LS4wOCAxMS44OTctLjA4IDEzLjUyNiAwIDEuMzA0Ljg5IDIuODUzIDMuMzE2IDIuMzY0IDE5LjQxMi02LjUyIDMzLjQwNS0yNC45MzUgMzMuNDA1LTQ2LjY5MUM5Ny43MDcgMjIgNzUuNzg4IDAgNDguODU0IDB6IiBmaWxsPSIjMjQyOTJmIi8+PC9zdmc+"},7610:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"user-interface-overview/specification","title":"The specification","description":"View your specification","source":"@site/docs/user-interface-overview/specification.md","sourceDirName":"user-interface-overview","slug":"/user-interface-overview/specification","permalink":"/spec-up-t-website/docs/user-interface-overview/specification","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/user-interface-overview/specification.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":2,"frontMatter":{"sidebar_position":2,"slug":"specification"},"sidebar":"tutorialSidebar","previous":{"title":"Command Line Menu","permalink":"/spec-up-t-website/docs/user-interface-overview/command-line-menu"},"next":{"title":"Role-Based Guides","permalink":"/spec-up-t-website/docs/category/role-based-guides"}}');var s=t(4848),o=t(8453);const c={sidebar_position:2,slug:"specification"},r="The specification",a={},l=[{value:"View your specification",id:"view-your-specification",level:2},{value:"Via file:///",id:"via-file",level:3},{value:"Via http://",id:"via-http",level:3},{value:"Explanation of the buttons in the specification",id:"explanation-of-the-buttons-in-the-specification",level:2},{value:"Terms",id:"terms",level:3},{value:"External references",id:"external-references",level:3}];function d(e){const i={admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"the-specification",children:"The specification"})}),"\n",(0,s.jsx)(i.h2,{id:"view-your-specification",children:"View your specification"}),"\n",(0,s.jsxs)(i.p,{children:["Your specification is stored in ",(0,s.jsx)(i.code,{children:"index.html"}),": the end result. You should view it in a browser. There are two ways to do this:"]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["via ",(0,s.jsx)(i.code,{children:"file:///"})]}),"\n",(0,s.jsxs)(i.li,{children:["via ",(0,s.jsx)(i.code,{children:"http://"})]}),"\n"]}),"\n",(0,s.jsxs)(i.h3,{id:"via-file",children:["Via ",(0,s.jsx)(i.code,{children:"file:///"})]}),"\n",(0,s.jsxs)(i.p,{children:["The simplest way to do so is via ",(0,s.jsx)(i.code,{children:"file:///"}),":"]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["go to the ",(0,s.jsx)(i.code,{children:"index.html"})," file with your Explorer, Finder, or other file manager"]}),"\n",(0,s.jsx)(i.li,{children:"double-click on it. Usually, it now opens in your browser."}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"If not, go to the browser and try to open the file from the browser menu."}),"\n",(0,s.jsxs)(i.p,{children:["This way, you open the ",(0,s.jsx)(i.code,{children:"index.html"})," file via the ",(0,s.jsx)(i.code,{children:"file protocol"})," (\u201c",(0,s.jsx)(i.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,s.jsxs)(i.h3,{id:"via-http",children:["Via ",(0,s.jsx)(i.code,{children:"http://"})]}),"\n",(0,s.jsxs)(i.p,{children:["You can also access it via HTTP. You then need to place the ",(0,s.jsx)(i.code,{children:"index.html"})," file on a web server and access it through a browser using the URL under which the file is accessible."]}),"\n",(0,s.jsx)(i.p,{children:"This way, you can share it with the world by sharing the URL."}),"\n",(0,s.jsx)(i.p,{children:'If you follow the most likely scenario, namely, you host your specification on GitHub Pages, then you look at it "via HTTP.\u201d'}),"\n",(0,s.jsxs)(i.admonition,{type:"info",children:[(0,s.jsxs)(i.p,{children:["\u201cVia ",(0,s.jsx)(i.code,{children:"http://"}),"\u201d is a complicated way of saying that you are just looking at your specifications via the Internet, just like you are looking at a Wikipedia page, etc."]}),(0,s.jsxs)(i.p,{children:["However, here it is briefly necessary to mention this because you can also double-click on the file and look \u201cvia ",(0,s.jsx)(i.code,{children:"file:///"}),"\u201d."]})]}),"\n",(0,s.jsx)(i.h2,{id:"explanation-of-the-buttons-in-the-specification",children:"Explanation of the buttons in the specification"}),"\n",(0,s.jsx)(i.h3,{id:"terms",children:"Terms"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Button"}),(0,s.jsx)(i.th,{children:"Explanation"})]})}),(0,s.jsxs)(i.tbody,{children:[(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"\ud83d\udd8a\ufe0f"})}),(0,s.jsx)(i.td,{children:"Link to the term file in the Github repo in a new tab"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"\ud83d\udcc5"})}),(0,s.jsx)(i.td,{children:"Link to a GitHub page that shows a history of the edits in a new tab"})]})]})]}),"\n",(0,s.jsx)(i.h3,{id:"external-references",children:"External references"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Button"}),(0,s.jsx)(i.th,{children:"Explanation"})]})}),(0,s.jsxs)(i.tbody,{children:[(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"xref"})}),(0,s.jsx)(i.td,{children:"Show the local snapshot of the referenced term, created at the moment the xref was made."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:["xref < > ",(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"Show diff between the local snapshot of the latest version and the referenced version"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," xref < > ",(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"A Diff between the latest commit hash of the definition and the commit hash referenced when the link was created."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," xref"]})}),(0,s.jsx)(i.td,{children:"Go to the repo page of the definition\u2018s version referenced when the link was created."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"Go to the repo page of the definition\u2018s latest version."})]})]})]})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,i,t)=>{t.d(i,{R:()=>c,x:()=>r});var n=t(6540);const s={},o=n.createContext(s);function c(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9729],{4247:(e,i,t)=>{t.d(i,{A:()=>n});const n="data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iOTgiIGhlaWdodD0iOTYiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik00OC44NTQgMEMyMS44MzkgMCAwIDIyIDAgNDkuMjE3YzAgMjEuNzU2IDEzLjk5MyA0MC4xNzIgMzMuNDA1IDQ2LjY5IDIuNDI3LjQ5IDMuMzE2LTEuMDU5IDMuMzE2LTIuMzYyIDAtMS4xNDEtLjA4LTUuMDUyLS4wOC05LjEyNy0xMy41OSAyLjkzNC0xNi40Mi01Ljg2Ny0xNi40Mi01Ljg2Ny0yLjE4NC01LjcwNC01LjQyLTcuMTctNS40Mi03LjE3LTQuNDQ4LTMuMDE1LjMyNC0zLjAxNS4zMjQtMy4wMTUgNC45MzQuMzI2IDcuNTIzIDUuMDUyIDcuNTIzIDUuMDUyIDQuMzY3IDcuNDk2IDExLjQwNCA1LjM3OCAxNC4yMzUgNC4wNzQuNDA0LTMuMTc4IDEuNjk5LTUuMzc4IDMuMDc0LTYuNi0xMC44MzktMS4xNDEtMjIuMjQzLTUuMzc4LTIyLjI0My0yNC4yODMgMC01LjM3OCAxLjk0LTkuNzc4IDUuMDE0LTEzLjItLjQ4NS0xLjIyMi0yLjE4NC02LjI3NS40ODYtMTMuMDM4IDAgMCA0LjEyNS0xLjMwNCAxMy40MjYgNS4wNTJhNDYuOTcgNDYuOTcgMCAwIDEgMTIuMjE0LTEuNjNjNC4xMjUgMCA4LjMzLjU3MSAxMi4yMTMgMS42MyA5LjMwMi02LjM1NiAxMy40MjctNS4wNTIgMTMuNDI3LTUuMDUyIDIuNjcgNi43NjMuOTcgMTEuODE2LjQ4NSAxMy4wMzggMy4xNTUgMy40MjIgNS4wMTUgNy44MjIgNS4wMTUgMTMuMiAwIDE4LjkwNS0xMS40MDQgMjMuMDYtMjIuMzI0IDI0LjI4MyAxLjc4IDEuNTQ4IDMuMzE2IDQuNDgxIDMuMzE2IDkuMTI2IDAgNi42LS4wOCAxMS44OTctLjA4IDEzLjUyNiAwIDEuMzA0Ljg5IDIuODUzIDMuMzE2IDIuMzY0IDE5LjQxMi02LjUyIDMzLjQwNS0yNC45MzUgMzMuNDA1LTQ2LjY5MUM5Ny43MDcgMjIgNzUuNzg4IDAgNDguODU0IDB6IiBmaWxsPSIjMjQyOTJmIi8+PC9zdmc+"},7610:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>c,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"user-interface-overview/specification","title":"The specification","description":"View your specification","source":"@site/docs/user-interface-overview/specification.md","sourceDirName":"user-interface-overview","slug":"/user-interface-overview/specification","permalink":"/spec-up-t-website/docs/user-interface-overview/specification","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/user-interface-overview/specification.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":2,"frontMatter":{"sidebar_position":2,"slug":"specification"},"sidebar":"tutorialSidebar","previous":{"title":"Command Line Menu","permalink":"/spec-up-t-website/docs/user-interface-overview/command-line-menu"},"next":{"title":"Role-Based Guides","permalink":"/spec-up-t-website/docs/category/role-based-guides"}}');var s=t(4848),o=t(8453);const c={sidebar_position:2,slug:"specification"},r="The specification",a={},l=[{value:"View your specification",id:"view-your-specification",level:2},{value:"Via file:///",id:"via-file",level:3},{value:"Via http://",id:"via-http",level:3},{value:"Explanation of the buttons in the specification",id:"explanation-of-the-buttons-in-the-specification",level:2},{value:"Terms",id:"terms",level:3},{value:"External references",id:"external-references",level:3}];function d(e){const i={admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",img:"img",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.header,{children:(0,s.jsx)(i.h1,{id:"the-specification",children:"The specification"})}),"\n",(0,s.jsx)(i.h2,{id:"view-your-specification",children:"View your specification"}),"\n",(0,s.jsxs)(i.p,{children:["Your specification is stored in ",(0,s.jsx)(i.code,{children:"index.html"}),": the end result. You should view it in a browser. There are two ways to do this:"]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["via ",(0,s.jsx)(i.code,{children:"file:///"})]}),"\n",(0,s.jsxs)(i.li,{children:["via ",(0,s.jsx)(i.code,{children:"http://"})]}),"\n"]}),"\n",(0,s.jsxs)(i.h3,{id:"via-file",children:["Via ",(0,s.jsx)(i.code,{children:"file:///"})]}),"\n",(0,s.jsxs)(i.p,{children:["The simplest way to do so is via ",(0,s.jsx)(i.code,{children:"file:///"}),":"]}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:["go to the ",(0,s.jsx)(i.code,{children:"index.html"})," file with your Explorer, Finder, or other file manager"]}),"\n",(0,s.jsx)(i.li,{children:"double-click on it. Usually, it now opens in your browser."}),"\n"]}),"\n",(0,s.jsx)(i.p,{children:"If not, go to the browser and try to open the file from the browser menu."}),"\n",(0,s.jsxs)(i.p,{children:["This way, you open the ",(0,s.jsx)(i.code,{children:"index.html"})," file via the ",(0,s.jsx)(i.code,{children:"file protocol"})," (\u201c",(0,s.jsx)(i.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,s.jsxs)(i.h3,{id:"via-http",children:["Via ",(0,s.jsx)(i.code,{children:"http://"})]}),"\n",(0,s.jsxs)(i.p,{children:["You can also access it via HTTP. You then need to place the ",(0,s.jsx)(i.code,{children:"index.html"})," file on a web server and access it through a browser using the URL under which the file is accessible."]}),"\n",(0,s.jsx)(i.p,{children:"This way, you can share it with the world by sharing the URL."}),"\n",(0,s.jsx)(i.p,{children:'If you follow the most likely scenario, namely, you host your specification on GitHub Pages, then you look at it "via HTTP.\u201d'}),"\n",(0,s.jsxs)(i.admonition,{type:"info",children:[(0,s.jsxs)(i.p,{children:["\u201cVia ",(0,s.jsx)(i.code,{children:"http://"}),"\u201d is a complicated way of saying that you are just looking at your specifications via the Internet, just like you are looking at a Wikipedia page, etc."]}),(0,s.jsxs)(i.p,{children:["However, here it is briefly necessary to mention this because you can also double-click on the file and look \u201cvia ",(0,s.jsx)(i.code,{children:"file:///"}),"\u201d."]})]}),"\n",(0,s.jsx)(i.h2,{id:"explanation-of-the-buttons-in-the-specification",children:"Explanation of the buttons in the specification"}),"\n",(0,s.jsx)(i.h3,{id:"terms",children:"Terms"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Button"}),(0,s.jsx)(i.th,{children:"Explanation"})]})}),(0,s.jsxs)(i.tbody,{children:[(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"\ud83d\udd8a\ufe0f"})}),(0,s.jsx)(i.td,{children:"Link to the term file in the Github repo in a new tab"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"\ud83d\udcc5"})}),(0,s.jsx)(i.td,{children:"Link to a GitHub page that shows a history of the edits in a new tab"})]})]})]}),"\n",(0,s.jsx)(i.h3,{id:"external-references",children:"External references"}),"\n",(0,s.jsxs)(i.table,{children:[(0,s.jsx)(i.thead,{children:(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.th,{children:"Button"}),(0,s.jsx)(i.th,{children:"Explanation"})]})}),(0,s.jsxs)(i.tbody,{children:[(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsx)("span",{className:"button-style-imitation",children:"xref"})}),(0,s.jsx)(i.td,{children:"Show the local snapshot of the referenced term, created at the moment the xref was made."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:["xref < > ",(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"Show diff between the local snapshot of the latest version and the referenced version"})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," xref < > ",(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"A Diff between the latest commit hash of the definition and the commit hash referenced when the link was created."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," xref"]})}),(0,s.jsx)(i.td,{children:"Go to the repo page of the definition\u2018s version referenced when the link was created."})]}),(0,s.jsxs)(i.tr,{children:[(0,s.jsx)(i.td,{children:(0,s.jsxs)("span",{className:"button-style-imitation",children:[(0,s.jsx)(i.img,{alt:"GitHub Mark",src:t(4247).A+"",width:"98",height:"96"})," now"]})}),(0,s.jsx)(i.td,{children:"Go to the repo page of the definition\u2018s latest version."})]})]})]})]})}function h(e={}){const{wrapper:i}={...(0,o.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,i,t)=>{t.d(i,{R:()=>c,x:()=>r});var n=t(6540);const s={},o=n.createContext(s);function c(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(o.Provider,{value:i},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/83703093.355c8260.js b/assets/js/83703093.005b8093.js
similarity index 98%
rename from assets/js/83703093.355c8260.js
rename to assets/js/83703093.005b8093.js
index fea02e11..805478c9 100644
--- a/assets/js/83703093.355c8260.js
+++ b/assets/js/83703093.005b8093.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1400],{6821:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"developer-documentation/code-overview/files-directories/starterpack","title":"Starterpack (via NPX)","description":"create-spec-up-t-starterpack.js","source":"@site/docs/developer-documentation/code-overview/files-directories/starterpack.md","sourceDirName":"developer-documentation/code-overview/files-directories","slug":"/developer-documentation/code-overview/files-directories/starterpack","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/starterpack","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/code-overview/files-directories/starterpack.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Overview","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview"},"next":{"title":"Workflow abstraction","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/workflow-abstraction"}}');var i=s(4848),c=s(8453);const n={sidebar_position:1},o="Starterpack (via NPX)",a={},d=[{value:"create-spec-up-t-starterpack.js",id:"create-spec-up-t-starterpackjs",level:2},{value:"messages.js",id:"messagesjs",level:2},{value:"start.js",id:"startjs",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"starterpack-via-npx",children:"Starterpack (via NPX)"})}),"\n",(0,i.jsx)("div",{class:"filesystemlayout",children:(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-sh",children:"\n\u251c\u2500\u2500 create-spec-up-t-starterpack.js\n\u251c\u2500\u2500 messages.js\n\u251c\u2500\u2500 package.spec-up-t.json\n\u2514\u2500\u2500 start.js\n"})})}),"\n",(0,i.jsx)(t.h2,{id:"create-spec-up-t-starterpackjs",children:(0,i.jsx)(t.code,{children:"create-spec-up-t-starterpack.js"})}),"\n",(0,i.jsx)(t.p,{children:"This script is called via NPX and starts the installation process. What it does:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Handle file system operations (create the target directory etc.)"}),"\n",(0,i.jsx)(t.li,{children:"Initialize Git"}),"\n",(0,i.jsxs)(t.li,{children:["Initialize npm","\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["copy ",(0,i.jsx)(t.code,{children:"package.spec-up-t.json"})," to the target directory"]}),"\n",(0,i.jsxs)(t.li,{children:["rename to ",(0,i.jsx)(t.code,{children:"package.json"})]}),"\n",(0,i.jsxs)(t.li,{children:["install the ",(0,i.jsx)(t.code,{children:"spec-up-t"})," npm package"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["Hand over to ",(0,i.jsx)(t.code,{children:"install.js"})," in the now available ",(0,i.jsx)(t.code,{children:"spec-up-t"})," package."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"messagesjs",children:(0,i.jsx)(t.code,{children:"messages.js"})}),"\n",(0,i.jsx)(t.p,{children:"Contains messages intended for feedback to the user."}),"\n",(0,i.jsx)(t.h2,{id:"startjs",children:(0,i.jsx)(t.code,{children:"start.js"})}),"\n",(0,i.jsx)(t.p,{children:"Work in progress: GitHub Action Workflow."})]})}function p(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>n,x:()=>o});var r=s(6540);const i={},c=r.createContext(i);function n(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1400],{6821:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>r,toc:()=>d});const r=JSON.parse('{"id":"developer-documentation/code-overview/files-directories/starterpack","title":"Starterpack (via NPX)","description":"create-spec-up-t-starterpack.js","source":"@site/docs/developer-documentation/code-overview/files-directories/starterpack.md","sourceDirName":"developer-documentation/code-overview/files-directories","slug":"/developer-documentation/code-overview/files-directories/starterpack","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/starterpack","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/code-overview/files-directories/starterpack.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Overview","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview"},"next":{"title":"Workflow abstraction","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/workflow-abstraction"}}');var i=s(4848),c=s(8453);const n={sidebar_position:1},o="Starterpack (via NPX)",a={},d=[{value:"create-spec-up-t-starterpack.js",id:"create-spec-up-t-starterpackjs",level:2},{value:"messages.js",id:"messagesjs",level:2},{value:"start.js",id:"startjs",level:2}];function l(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",...(0,c.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"starterpack-via-npx",children:"Starterpack (via NPX)"})}),"\n",(0,i.jsx)("div",{class:"filesystemlayout",children:(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-sh",children:"\n\u251c\u2500\u2500 create-spec-up-t-starterpack.js\n\u251c\u2500\u2500 messages.js\n\u251c\u2500\u2500 package.spec-up-t.json\n\u2514\u2500\u2500 start.js\n"})})}),"\n",(0,i.jsx)(t.h2,{id:"create-spec-up-t-starterpackjs",children:(0,i.jsx)(t.code,{children:"create-spec-up-t-starterpack.js"})}),"\n",(0,i.jsx)(t.p,{children:"This script is called via NPX and starts the installation process. What it does:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsx)(t.li,{children:"Handle file system operations (create the target directory etc.)"}),"\n",(0,i.jsx)(t.li,{children:"Initialize Git"}),"\n",(0,i.jsxs)(t.li,{children:["Initialize npm","\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["copy ",(0,i.jsx)(t.code,{children:"package.spec-up-t.json"})," to the target directory"]}),"\n",(0,i.jsxs)(t.li,{children:["rename to ",(0,i.jsx)(t.code,{children:"package.json"})]}),"\n",(0,i.jsxs)(t.li,{children:["install the ",(0,i.jsx)(t.code,{children:"spec-up-t"})," npm package"]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["Hand over to ",(0,i.jsx)(t.code,{children:"install.js"})," in the now available ",(0,i.jsx)(t.code,{children:"spec-up-t"})," package."]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"messagesjs",children:(0,i.jsx)(t.code,{children:"messages.js"})}),"\n",(0,i.jsx)(t.p,{children:"Contains messages intended for feedback to the user."}),"\n",(0,i.jsx)(t.h2,{id:"startjs",children:(0,i.jsx)(t.code,{children:"start.js"})}),"\n",(0,i.jsx)(t.p,{children:"Work in progress: GitHub Action Workflow."})]})}function p(e={}){const{wrapper:t}={...(0,c.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>n,x:()=>o});var r=s(6540);const i={},c=r.createContext(i);function n(e){const t=r.useContext(c);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:n(e.components),r.createElement(c.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/84de3d6b.4ce36b54.js b/assets/js/84de3d6b.ad2f531b.js
similarity index 98%
rename from assets/js/84de3d6b.4ce36b54.js
rename to assets/js/84de3d6b.ad2f531b.js
index 6600d947..e7348c7d 100644
--- a/assets/js/84de3d6b.4ce36b54.js
+++ b/assets/js/84de3d6b.ad2f531b.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9151],{8453:(e,t,i)=>{i.d(t,{R:()=>s,x:()=>a});var n=i(6540);const r={},o=n.createContext(r);function s(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(o.Provider,{value:t},e.children)}},9843:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"See the demo site.","source":"@site/docs/various-roles/terminology-authors-guide/term-references.md","sourceDirName":"various-roles/terminology-authors-guide","slug":"/various-roles/terminology-authors-guide/term-references","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/terminology-authors-guide/term-references.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction"},"next":{"title":"External Term References","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references"}}');var r=i(4848),o=i(8453);const s={sidebar_position:2},a="Term References",d={},l=[{value:"Definition Lists",id:"definition-lists",level:2},{value:"What are the \u201c~\u201d ?",id:"what-are-the--",level:2},{value:"Table-defined Terms",id:"table-defined-terms",level:2}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"term-references",children:"Term References"})}),"\n",(0,r.jsxs)(t.p,{children:["See the ",(0,r.jsx)(t.a,{href:"https://trustoverip.github.io/spec-up-t-demo-on-documentation-website/#term:aaa-example-1",children:"demo site"}),"."]}),"\n",(0,r.jsx)(t.admonition,{type:"info",children:(0,r.jsx)(t.p,{children:"If you've been working with Spec-Up, it's good to know that adding a term file doesn't require adding it to the configuration file anymore; it's automatic now."})}),"\n",(0,r.jsx)(t.h2,{id:"definition-lists",children:"Definition Lists"}),"\n",(0,r.jsx)(t.p,{children:"Many specs may want to include a section for terminology references, and Definition Lists are a great way to do that. Here's how to leverage Spec-Up's automatic term reference features via Definition List markup:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-markdown",children:"[[def: Term 1, Term One]]:\n~ This is the first term we will define.\n\n~ Second paragraph\n\n"})}),"\n",(0,r.jsxs)(t.p,{children:["Now let's refer to some of the terms defined above to show how the auto-linking of terms works. Additionally, as long as you define your terms using Definition Lists (as seen in the markdown above), you will be able to hover any reference to a term to see a tooltip with its definition. See the ",(0,r.jsx)(t.a,{href:"https://trustoverip.github.io/spec-up-t-demo-on-documentation-website/#term:term-1",children:"demo site"}),"."]}),"\n",(0,r.jsx)(t.h2,{id:"what-are-the--",children:"What are the \u201c~\u201d ?"}),"\n",(0,r.jsx)(t.p,{children:"That is how Markdown indicates that it is a , the definition part of a \u201cdefinition list.\u201d Just use it for each sentence. In the future, we want to catch this automated so that if you accidentally forget it, you still get it right."}),"\n",(0,r.jsx)(t.p,{children:"What goes wrong if you don't? You see, some things don't fold in and out properly, for example, because the structure of the HTML is no longer correct."}),"\n",(0,r.jsx)(t.h2,{id:"table-defined-terms",children:"Table-defined Terms"}),"\n",(0,r.jsx)(t.p,{children:"You can also reference table-oriented terms and definitions which are decomposed into heading-titled attributes in distinct cells:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-markdown",children:"Variable | Default Value | Max Value\n------------------- | ------------- | ---------\n[[def: Variable 1]] | 123 | 9999\n"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Variable"}),(0,r.jsx)(t.th,{children:"Default Value"}),(0,r.jsx)(t.th,{children:"Max Value"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"[[def: Variable 1]]"}),(0,r.jsx)(t.td,{children:"123"}),(0,r.jsx)(t.td,{children:"9999"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Anytime you add a definition of a term in the first column of a table, like [[ref: Variable 1]], it will link to the cell and display a tooltip with the entire set of row values when you hover the term."})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9151],{8453:(e,t,i)=>{i.d(t,{R:()=>s,x:()=>a});var n=i(6540);const r={},o=n.createContext(r);function s(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(o.Provider,{value:t},e.children)}},9843:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>n,toc:()=>l});const n=JSON.parse('{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"See the demo site.","source":"@site/docs/various-roles/terminology-authors-guide/term-references.md","sourceDirName":"various-roles/terminology-authors-guide","slug":"/various-roles/terminology-authors-guide/term-references","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/terminology-authors-guide/term-references.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction"},"next":{"title":"External Term References","permalink":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references"}}');var r=i(4848),o=i(8453);const s={sidebar_position:2},a="Term References",d={},l=[{value:"Definition Lists",id:"definition-lists",level:2},{value:"What are the \u201c~\u201d ?",id:"what-are-the--",level:2},{value:"Table-defined Terms",id:"table-defined-terms",level:2}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,o.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"term-references",children:"Term References"})}),"\n",(0,r.jsxs)(t.p,{children:["See the ",(0,r.jsx)(t.a,{href:"https://trustoverip.github.io/spec-up-t-demo-on-documentation-website/#term:aaa-example-1",children:"demo site"}),"."]}),"\n",(0,r.jsx)(t.admonition,{type:"info",children:(0,r.jsx)(t.p,{children:"If you've been working with Spec-Up, it's good to know that adding a term file doesn't require adding it to the configuration file anymore; it's automatic now."})}),"\n",(0,r.jsx)(t.h2,{id:"definition-lists",children:"Definition Lists"}),"\n",(0,r.jsx)(t.p,{children:"Many specs may want to include a section for terminology references, and Definition Lists are a great way to do that. Here's how to leverage Spec-Up's automatic term reference features via Definition List markup:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-markdown",children:"[[def: Term 1, Term One]]:\n~ This is the first term we will define.\n\n~ Second paragraph\n\n"})}),"\n",(0,r.jsxs)(t.p,{children:["Now let's refer to some of the terms defined above to show how the auto-linking of terms works. Additionally, as long as you define your terms using Definition Lists (as seen in the markdown above), you will be able to hover any reference to a term to see a tooltip with its definition. See the ",(0,r.jsx)(t.a,{href:"https://trustoverip.github.io/spec-up-t-demo-on-documentation-website/#term:term-1",children:"demo site"}),"."]}),"\n",(0,r.jsx)(t.h2,{id:"what-are-the--",children:"What are the \u201c~\u201d ?"}),"\n",(0,r.jsx)(t.p,{children:"That is how Markdown indicates that it is a , the definition part of a \u201cdefinition list.\u201d Just use it for each sentence. In the future, we want to catch this automated so that if you accidentally forget it, you still get it right."}),"\n",(0,r.jsx)(t.p,{children:"What goes wrong if you don't? You see, some things don't fold in and out properly, for example, because the structure of the HTML is no longer correct."}),"\n",(0,r.jsx)(t.h2,{id:"table-defined-terms",children:"Table-defined Terms"}),"\n",(0,r.jsx)(t.p,{children:"You can also reference table-oriented terms and definitions which are decomposed into heading-titled attributes in distinct cells:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-markdown",children:"Variable | Default Value | Max Value\n------------------- | ------------- | ---------\n[[def: Variable 1]] | 123 | 9999\n"})}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Variable"}),(0,r.jsx)(t.th,{children:"Default Value"}),(0,r.jsx)(t.th,{children:"Max Value"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"[[def: Variable 1]]"}),(0,r.jsx)(t.td,{children:"123"}),(0,r.jsx)(t.td,{children:"9999"})]})})]}),"\n",(0,r.jsx)(t.p,{children:"Anytime you add a definition of a term in the first column of a table, like [[ref: Variable 1]], it will link to the cell and display a tooltip with the entire set of row values when you hover the term."})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}}}]);
\ No newline at end of file
diff --git a/assets/js/8fd02abe.2f53e7f5.js b/assets/js/8fd02abe.0c74275a.js
similarity index 98%
rename from assets/js/8fd02abe.2f53e7f5.js
rename to assets/js/8fd02abe.0c74275a.js
index 8c329d62..d30a4201 100644
--- a/assets/js/8fd02abe.2f53e7f5.js
+++ b/assets/js/8fd02abe.0c74275a.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8413],{1237:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"developer-documentation/back-end/github-api-response","title":"GitHub API response","description":"Example","source":"@site/docs/developer-documentation/back-end/github-api-response.md","sourceDirName":"developer-documentation/back-end","slug":"/developer-documentation/back-end/github-api-response","permalink":"/spec-up-t-website/docs/developer-documentation/back-end/github-api-response","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/back-end/github-api-response.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/developer-documentation/back-end/intro"},"next":{"title":"Code Overview","permalink":"/spec-up-t-website/docs/category/code-overview"}}');var i=s(4848),r=s(8453);const o={sidebar_position:1},a="GitHub API response",u={},c=[{value:"Example",id:"example",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"github-api-response",children:"GitHub API response"})}),"\n",(0,i.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(t.p,{children:"This is an example of a response from the GitHub API:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-json",children:"[\n {\n sha: '117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n node_id: 'C_kwDOMi-o_toAKDExN2I4NmZhNjc2YzBiZDMwMzBjMTZlOGJiYjg3ZWJhYTYxYWY1NzY',\n commit: {\n author: [Object],\n committer: [Object],\n message: 'first commit',\n tree: [Object],\n url: 'https://api.github.com/repos/****/****/git/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n comment_count: 0,\n verification: [Object]\n },\n url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n html_url: 'https://github.com/****/****/commit/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n comments_url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576/comments',\n author: {\n login: '****',\n id: 0,\n node_id: '****',\n avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',\n gravatar_id: '',\n url: 'https://api.github.com/users/****',\n html_url: 'https://github.com/****',\n followers_url: 'https://api.github.com/users/****/followers',\n following_url: 'https://api.github.com/users/****/following{/other_user}',\n gists_url: 'https://api.github.com/users/****/gists{/gist_id}',\n starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',\n subscriptions_url: 'https://api.github.com/users/****/subscriptions',\n organizations_url: 'https://api.github.com/users/****/orgs',\n repos_url: 'https://api.github.com/users/****/repos',\n events_url: 'https://api.github.com/users/****/events{/privacy}',\n received_events_url: 'https://api.github.com/users/****/received_events',\n type: 'User',\n site_admin: false\n },\n committer: {\n login: '****',\n id: 0,\n node_id: '****',\n avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',\n gravatar_id: '',\n url: 'https://api.github.com/users/****',\n html_url: 'https://github.com/****',\n followers_url: 'https://api.github.com/users/****/followers',\n following_url: 'https://api.github.com/users/****/following{/other_user}',\n gists_url: 'https://api.github.com/users/****/gists{/gist_id}',\n starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',\n subscriptions_url: 'https://api.github.com/users/****/subscriptions',\n organizations_url: 'https://api.github.com/users/****/orgs',\n repos_url: 'https://api.github.com/users/****/repos',\n events_url: 'https://api.github.com/users/****/events{/privacy}',\n received_events_url: 'https://api.github.com/users/****/received_events',\n type: 'User',\n site_admin: false\n },\n parents: []\n }\n]\n\n"})})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var n=s(6540);const i={},r=n.createContext(i);function o(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8413],{1237:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"developer-documentation/back-end/github-api-response","title":"GitHub API response","description":"Example","source":"@site/docs/developer-documentation/back-end/github-api-response.md","sourceDirName":"developer-documentation/back-end","slug":"/developer-documentation/back-end/github-api-response","permalink":"/spec-up-t-website/docs/developer-documentation/back-end/github-api-response","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/back-end/github-api-response.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Intro","permalink":"/spec-up-t-website/docs/developer-documentation/back-end/intro"},"next":{"title":"Code Overview","permalink":"/spec-up-t-website/docs/category/code-overview"}}');var i=s(4848),r=s(8453);const o={sidebar_position:1},a="GitHub API response",u={},c=[{value:"Example",id:"example",level:2}];function p(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"github-api-response",children:"GitHub API response"})}),"\n",(0,i.jsx)(t.h2,{id:"example",children:"Example"}),"\n",(0,i.jsx)(t.p,{children:"This is an example of a response from the GitHub API:"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-json",children:"[\n {\n sha: '117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n node_id: 'C_kwDOMi-o_toAKDExN2I4NmZhNjc2YzBiZDMwMzBjMTZlOGJiYjg3ZWJhYTYxYWY1NzY',\n commit: {\n author: [Object],\n committer: [Object],\n message: 'first commit',\n tree: [Object],\n url: 'https://api.github.com/repos/****/****/git/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n comment_count: 0,\n verification: [Object]\n },\n url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n html_url: 'https://github.com/****/****/commit/117b86fa676c0bd3030c16e8bbb87ebaa61af576',\n comments_url: 'https://api.github.com/repos/****/****/commits/117b86fa676c0bd3030c16e8bbb87ebaa61af576/comments',\n author: {\n login: '****',\n id: 0,\n node_id: '****',\n avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',\n gravatar_id: '',\n url: 'https://api.github.com/users/****',\n html_url: 'https://github.com/****',\n followers_url: 'https://api.github.com/users/****/followers',\n following_url: 'https://api.github.com/users/****/following{/other_user}',\n gists_url: 'https://api.github.com/users/****/gists{/gist_id}',\n starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',\n subscriptions_url: 'https://api.github.com/users/****/subscriptions',\n organizations_url: 'https://api.github.com/users/****/orgs',\n repos_url: 'https://api.github.com/users/****/repos',\n events_url: 'https://api.github.com/users/****/events{/privacy}',\n received_events_url: 'https://api.github.com/users/****/received_events',\n type: 'User',\n site_admin: false\n },\n committer: {\n login: '****',\n id: 0,\n node_id: '****',\n avatar_url: 'https://avatars.githubusercontent.com/u/****?v=4',\n gravatar_id: '',\n url: 'https://api.github.com/users/****',\n html_url: 'https://github.com/****',\n followers_url: 'https://api.github.com/users/****/followers',\n following_url: 'https://api.github.com/users/****/following{/other_user}',\n gists_url: 'https://api.github.com/users/****/gists{/gist_id}',\n starred_url: 'https://api.github.com/users/****/starred{/owner}{/repo}',\n subscriptions_url: 'https://api.github.com/users/****/subscriptions',\n organizations_url: 'https://api.github.com/users/****/orgs',\n repos_url: 'https://api.github.com/users/****/repos',\n events_url: 'https://api.github.com/users/****/events{/privacy}',\n received_events_url: 'https://api.github.com/users/****/received_events',\n type: 'User',\n site_admin: false\n },\n parents: []\n }\n]\n\n"})})]})}function l(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>a});var n=s(6540);const i={},r=n.createContext(i);function o(e){const t=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),n.createElement(r.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9d6756e2.e0a26c04.js b/assets/js/9d6756e2.16ac37ea.js
similarity index 99%
rename from assets/js/9d6756e2.e0a26c04.js
rename to assets/js/9d6756e2.16ac37ea.js
index 704d1631..4bd5b586 100644
--- a/assets/js/9d6756e2.e0a26c04.js
+++ b/assets/js/9d6756e2.16ac37ea.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6413],{8307:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"developer-documentation/code-overview/files-directories/spec-up-t/overview","title":"Overview","description":"Intro","source":"@site/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md","sourceDirName":"developer-documentation/code-overview/files-directories/spec-up-t","slug":"/developer-documentation/code-overview/files-directories/spec-up-t/overview","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Spec-Up-T (via npm)","permalink":"/spec-up-t-website/docs/category/spec-up-t-via-npm"},"next":{"title":"Starterpack (via NPX)","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/starterpack"}}');var i=s(4848),r=s(8453);const o={sidebar_position:1},c="Overview",d={},a=[{value:"Intro",id:"intro",level:2},{value:"Abstracted overview",id:"abstracted-overview",level:2},{value:"Tip",id:"tip",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"overview",children:"Overview"})}),"\n",(0,i.jsx)(n.h2,{id:"intro",children:"Intro"}),"\n",(0,i.jsxs)(n.p,{children:["Below is a summary of the files and folders found in the ",(0,i.jsx)(n.code,{children:"spec-up-t"})," ",(0,i.jsx)(n.a,{href:"https://github.com/trustoverip/spec-up-t",children:"GitHub repository"})," / ",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/spec-up-t",children:"npm package"}),"."]}),"\n",(0,i.jsxs)(n.admonition,{type:"info",children:[(0,i.jsx)(n.p,{children:"It is essential to understand:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["that the files and directories listed below can be found in the ",(0,i.jsx)(n.code,{children:"spec-up-t"})," npm package installed in the ",(0,i.jsx)(n.code,{children:"node_modules"})," directory of a working ",(0,i.jsx)(n.strong,{children:"Spec-Up-T installation"})]}),"\n",(0,i.jsxs)(n.li,{children:["that this working ",(0,i.jsx)(n.strong,{children:"Spec-Up-T installation"})," was created ",(0,i.jsx)(n.strong,{children:"from the boilerplate directory"})," inside this ",(0,i.jsx)(n.code,{children:"spec-up-t"})," npm package via NPX"]}),"\n"]})]}),"\n",(0,i.jsx)(n.h2,{id:"abstracted-overview",children:"Abstracted overview"}),"\n",(0,i.jsx)(n.p,{children:"Abstracted overview of files and directories in the Spec-Up-T GitHub repository (and npm package)."}),"\n",(0,i.jsxs)("div",{class:"filesystemlayout",children:[(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"\n./\n\u2502\n\u2502 \ud83d\udc47 GITHUB ACTIONS WORKFLOW\n\u2502\n\u251c\u2500\u2500 .github/\n\u2502\xa0\xa0 \u2514\u2500\u2500 workflows/\n\u2502\xa0\xa0 \u2514\u2500\u2500 render-specs.yml\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 CLIENT-SIDE (BROWSER) JAVASCRIPT AND CSS FILES\n\u2502\n\u251c\u2500\u2500 assets/\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \ud83d\udc47 COMPILED VIA GULP (FROM THE CSS AND JS FILES BELOW)\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 compiled/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 body.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 head.css\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 head.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 refs.json\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \xa0\xa0\ud83d\udc47 SOURCE FILES (TO BE COMPILED VIA GULP)\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 css/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 backToTop.css\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 js/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-href-to-snapshot-link.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2514\u2500\u2500 icons.svg\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 FONTS\n\u2502\n\u251c\u2500\u2500 fonts/\n\u2502\xa0\xa0 \u251c\u2500\u2500 KaTeX_AMS-Regular.ttf\n\u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 NODE JAVASCRIPT FILES\n\u2502\n\u251c\u2500\u2500 src/\n\u2502\xa0\xa0 \u251c\u2500\u2500 collectExternalReferences/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 checkRateLimit.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 fetchTermsFromGitHubRepository.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 matchTerm.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 processXTrefsData.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 setupFetchHeaders.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 config/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 paths.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \ud83d\udc47 CREATES NEW SPEC-UP-T \u201cINSTALLATION\u201d\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 install-from-boilerplate/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502 \ud83d\udc47 SPEC-UP-T BOILERPLATE: A FULL \u201cINSTALLATION\u201d\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 boilerplate/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 .github/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 workflows/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 fetch-and-push-xrefs.yml\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 render-specs.yml\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 assets/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 test.json\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 test.text\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 terms-definitions/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-1.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-2.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-3.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 term-4.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 example-markup-in-markdown.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec-body.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec-head.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 terms-and-definitions-intro.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 static/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 favicon.ico\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 logo.svg\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 .env.example\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 README.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 gitignore\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 specs.json\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502 \ud83d\udc47 FILES THAT COPY AND INITIALIZE THE BOILERPLATE DIRECTORY\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-gitignore-entries.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-scripts-keys.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-gitignore-entries.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-scripts-keys.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-system-files.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 copy-boilerplate.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 copy-system-files.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 custom-update.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 help.txt\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 install.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 menu.sh\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 postinstall-message.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502 \u2502\n\u2502 \u2502 \ud83d\udc47 GENERAL NODE FILES\n\u2502 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 utils/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 doesUrlExist.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 isLineWithDefinition.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 add-remove-xref-source.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 asset-map.json\n\u2502\xa0\xa0 \u251c\u2500\u2500 collect-external-references.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 configure.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-pdf.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-term-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-term-relations.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-versions-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 fix-markdown-files.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 freeze.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 init.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 insert-term-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 json-key-validator.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 markdown-it-extensions.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 prepare-tref.js\n\u2502\xa0\xa0 \u2514\u2500\u2500 references.js\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 ASSETS LIKE LOGO'S\n\u2502\n\u251c\u2500\u2500 static/\n\u2502\xa0\xa0 \u2514\u2500\u2500 specup_logo.png\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 THE TEMPLATE FOR INDEX.HTML WHERE EVERYTHING IS INJECTED INTO\n\u2502\n\u251c\u2500\u2500 templates/\n\u2502\xa0\xa0 \u2514\u2500\u2500 template.html\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 COMPILES CLIENT-SIDE FILES INTO ONE INDEX.HTML\n\u2502\n\u251c\u2500\u2500 gulpfile.js\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 ENTRY POINT FOR NODE SCRIPTS\n\u2502\n\u2514\u2500\u2500 index.js\n\n"})}),(0,i.jsx)(n.h2,{id:"tip",children:"Tip"}),(0,i.jsx)(n.p,{children:"Zoom in and out to get a better picture."}),(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Zoom in: Ctrl / Command + Plus sign (+)"}),"\n",(0,i.jsx)(n.li,{children:"Zoom out: Ctrl / Command + Minus sign (-)"}),"\n",(0,i.jsx)(n.li,{children:"Reset: Ctrl / Command + 0"}),"\n"]})})]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>c});var t=s(6540);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6413],{8307:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>c,default:()=>p,frontMatter:()=>o,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"developer-documentation/code-overview/files-directories/spec-up-t/overview","title":"Overview","description":"Intro","source":"@site/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md","sourceDirName":"developer-documentation/code-overview/files-directories/spec-up-t","slug":"/developer-documentation/code-overview/files-directories/spec-up-t/overview","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/code-overview/files-directories/spec-up-t/overview.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":1,"frontMatter":{"sidebar_position":1},"sidebar":"tutorialSidebar","previous":{"title":"Spec-Up-T (via npm)","permalink":"/spec-up-t-website/docs/category/spec-up-t-via-npm"},"next":{"title":"Starterpack (via NPX)","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/starterpack"}}');var i=s(4848),r=s(8453);const o={sidebar_position:1},c="Overview",d={},a=[{value:"Intro",id:"intro",level:2},{value:"Abstracted overview",id:"abstracted-overview",level:2},{value:"Tip",id:"tip",level:2}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"overview",children:"Overview"})}),"\n",(0,i.jsx)(n.h2,{id:"intro",children:"Intro"}),"\n",(0,i.jsxs)(n.p,{children:["Below is a summary of the files and folders found in the ",(0,i.jsx)(n.code,{children:"spec-up-t"})," ",(0,i.jsx)(n.a,{href:"https://github.com/trustoverip/spec-up-t",children:"GitHub repository"})," / ",(0,i.jsx)(n.a,{href:"https://www.npmjs.com/package/spec-up-t",children:"npm package"}),"."]}),"\n",(0,i.jsxs)(n.admonition,{type:"info",children:[(0,i.jsx)(n.p,{children:"It is essential to understand:"}),(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["that the files and directories listed below can be found in the ",(0,i.jsx)(n.code,{children:"spec-up-t"})," npm package installed in the ",(0,i.jsx)(n.code,{children:"node_modules"})," directory of a working ",(0,i.jsx)(n.strong,{children:"Spec-Up-T installation"})]}),"\n",(0,i.jsxs)(n.li,{children:["that this working ",(0,i.jsx)(n.strong,{children:"Spec-Up-T installation"})," was created ",(0,i.jsx)(n.strong,{children:"from the boilerplate directory"})," inside this ",(0,i.jsx)(n.code,{children:"spec-up-t"})," npm package via NPX"]}),"\n"]})]}),"\n",(0,i.jsx)(n.h2,{id:"abstracted-overview",children:"Abstracted overview"}),"\n",(0,i.jsx)(n.p,{children:"Abstracted overview of files and directories in the Spec-Up-T GitHub repository (and npm package)."}),"\n",(0,i.jsxs)("div",{class:"filesystemlayout",children:[(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"\n./\n\u2502\n\u2502 \ud83d\udc47 GITHUB ACTIONS WORKFLOW\n\u2502\n\u251c\u2500\u2500 .github/\n\u2502\xa0\xa0 \u2514\u2500\u2500 workflows/\n\u2502\xa0\xa0 \u2514\u2500\u2500 render-specs.yml\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 CLIENT-SIDE (BROWSER) JAVASCRIPT AND CSS FILES\n\u2502\n\u251c\u2500\u2500 assets/\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \ud83d\udc47 COMPILED VIA GULP (FROM THE CSS AND JS FILES BELOW)\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 compiled/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 body.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 head.css\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 head.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 refs.json\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \xa0\xa0\ud83d\udc47 SOURCE FILES (TO BE COMPILED VIA GULP)\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 css/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 backToTop.css\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 js/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-href-to-snapshot-link.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2514\u2500\u2500 icons.svg\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 FONTS\n\u2502\n\u251c\u2500\u2500 fonts/\n\u2502\xa0\xa0 \u251c\u2500\u2500 KaTeX_AMS-Regular.ttf\n\u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u251c\u2500\u2500 \u2026 etc\n\u2502\xa0\xa0 \u2514\u2500\u2500 \u2026 etc\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 NODE JAVASCRIPT FILES\n\u2502\n\u251c\u2500\u2500 src/\n\u2502\xa0\xa0 \u251c\u2500\u2500 collectExternalReferences/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 checkRateLimit.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 fetchTermsFromGitHubRepository.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 matchTerm.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 processXTrefsData.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 setupFetchHeaders.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 config/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 paths.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502 \ud83d\udc47 CREATES NEW SPEC-UP-T \u201cINSTALLATION\u201d\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 install-from-boilerplate/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502 \ud83d\udc47 SPEC-UP-T BOILERPLATE: A FULL \u201cINSTALLATION\u201d\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 boilerplate/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 .github/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 workflows/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 fetch-and-push-xrefs.yml\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 render-specs.yml\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 assets/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 test.json\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 test.text\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 terms-definitions/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-1.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-2.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 term-3.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 term-4.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 example-markup-in-markdown.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec-body.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 spec-head.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 terms-and-definitions-intro.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 static/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 favicon.ico\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 logo.svg\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 .env.example\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 README.md\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 gitignore\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 specs.json\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502 \ud83d\udc47 FILES THAT COPY AND INITIALIZE THE BOILERPLATE DIRECTORY\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-gitignore-entries.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 add-scripts-keys.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-gitignore-entries.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-scripts-keys.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 config-system-files.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 copy-boilerplate.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 copy-system-files.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 custom-update.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 help.txt\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 install.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 menu.sh\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 postinstall-message.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u2502\n\u2502 \u2502\n\u2502 \u2502 \ud83d\udc47 GENERAL NODE FILES\n\u2502 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 utils/\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u251c\u2500\u2500 doesUrlExist.js\n\u2502\xa0\xa0 \u2502\xa0\xa0 \u2514\u2500\u2500 isLineWithDefinition.js\n\u2502\xa0\xa0 \u2502\n\u2502\xa0\xa0 \u251c\u2500\u2500 add-remove-xref-source.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 asset-map.json\n\u2502\xa0\xa0 \u251c\u2500\u2500 collect-external-references.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 configure.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-pdf.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-term-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-term-relations.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 create-versions-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 fix-markdown-files.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 freeze.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 init.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 insert-term-index.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 json-key-validator.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 markdown-it-extensions.js\n\u2502\xa0\xa0 \u251c\u2500\u2500 prepare-tref.js\n\u2502\xa0\xa0 \u2514\u2500\u2500 references.js\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 ASSETS LIKE LOGO'S\n\u2502\n\u251c\u2500\u2500 static/\n\u2502\xa0\xa0 \u2514\u2500\u2500 specup_logo.png\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 THE TEMPLATE FOR INDEX.HTML WHERE EVERYTHING IS INJECTED INTO\n\u2502\n\u251c\u2500\u2500 templates/\n\u2502\xa0\xa0 \u2514\u2500\u2500 template.html\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 COMPILES CLIENT-SIDE FILES INTO ONE INDEX.HTML\n\u2502\n\u251c\u2500\u2500 gulpfile.js\n\u2502\n\u2502\n\u2502\n\u2502 \ud83d\udc47 ENTRY POINT FOR NODE SCRIPTS\n\u2502\n\u2514\u2500\u2500 index.js\n\n"})}),(0,i.jsx)(n.h2,{id:"tip",children:"Tip"}),(0,i.jsx)(n.p,{children:"Zoom in and out to get a better picture."}),(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Zoom in: Ctrl / Command + Plus sign (+)"}),"\n",(0,i.jsx)(n.li,{children:"Zoom out: Ctrl / Command + Minus sign (-)"}),"\n",(0,i.jsx)(n.li,{children:"Reset: Ctrl / Command + 0"}),"\n"]})})]})]})}function p(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},8453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>c});var t=s(6540);const i={},r=t.createContext(i);function o(e){const n=t.useContext(r);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/9d9f8394.a048f91b.js b/assets/js/9d9f8394.b2c47ac1.js
similarity index 98%
rename from assets/js/9d9f8394.a048f91b.js
rename to assets/js/9d9f8394.b2c47ac1.js
index 5ec9c723..784d0168 100644
--- a/assets/js/9d9f8394.a048f91b.js
+++ b/assets/js/9d9f8394.b2c47ac1.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9013],{269:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","source":"@site/docs/troubleshooting.md","sourceDirName":".","slug":"/troubleshooting","permalink":"/spec-up-t-website/docs/troubleshooting","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/troubleshooting.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":8,"frontMatter":{"sidebar_position":8},"sidebar":"tutorialSidebar","previous":{"title":"Maintaining this site","permalink":"/spec-up-t-website/docs/administrative-and-maintenance-tasks/this-site-maintainers"},"next":{"title":"F.A.Q.","permalink":"/spec-up-t-website/docs/faq"}}');var i=t(4848),r=t(8453);const o={sidebar_position:8},a="Troubleshooting",d={},l=[{value:"GitHub and API and limits",id:"github-and-api-and-limits",level:2},{value:"I am sure an external reference contains the term I am referencing, but it does not show",id:"i-am-sure-an-external-reference-contains-the-term-i-am-referencing-but-it-does-not-show",level:2},{value:"WSL2 users",id:"wsl2-users",level:2},{value:"Use Node.js versions 18+",id:"use-nodejs-versions-18",level:2}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"})}),"\n",(0,i.jsx)(n.p,{children:"Some tips in case of problems:"}),"\n",(0,i.jsx)(n.h2,{id:"github-and-api-and-limits",children:"GitHub and API and limits"}),"\n",(0,i.jsxs)(n.p,{children:["Problem: I want to look up an external reference (",(0,i.jsx)(n.em,{children:"xref"}),") but I get an error about GitHub and API and limits."]}),"\n",(0,i.jsxs)(n.p,{children:["Solution: ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/getting-started/github-token",children:"get a GitHub Token"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"i-am-sure-an-external-reference-contains-the-term-i-am-referencing-but-it-does-not-show",children:"I am sure an external reference contains the term I am referencing, but it does not show"}),"\n",(0,i.jsx)(n.p,{children:"Maybe the repository is not indexed by GitHub. Do a manual search on the term:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go to the repository"}),"\n",(0,i.jsxs)(n.li,{children:["Enter your search term in the search field that shows: \u201c",(0,i.jsx)(n.strong,{children:"Type / to search"}),"\u201d and enter."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If you see this:\n*\u201cThis repository's code has not been indexed yet. Try again later.\u201d *\nthe repository has not been indexed (yet)."}),"\n",(0,i.jsx)(n.p,{children:"You cannot directly trigger the indexing, but making a change by committing something helps."}),"\n",(0,i.jsx)(n.h2,{id:"wsl2-users",children:"WSL2 users"}),"\n",(0,i.jsxs)(n.p,{children:["WSL2 users are recommended to use the ",(0,i.jsx)(n.code,{children:"bash"})," option rather than ",(0,i.jsx)(n.code,{children:"PowerShell"})," in the terminal of Visual Studio Code."]}),"\n",(0,i.jsx)(n.h2,{id:"use-nodejs-versions-18",children:"Use Node.js versions 18+"}),"\n",(0,i.jsxs)(n.p,{children:["Spec-Up-T uses ",(0,i.jsx)(n.code,{children:"fetch"}),", which was ",(0,i.jsx)(n.a,{href:"https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch",children:"added in version 18"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"Install NVM if you haven't already. (Instructions not given here)."}),"\n",(0,i.jsx)(n.p,{children:"Then run Node.js version 18."})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9013],{269:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","source":"@site/docs/troubleshooting.md","sourceDirName":".","slug":"/troubleshooting","permalink":"/spec-up-t-website/docs/troubleshooting","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/troubleshooting.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":8,"frontMatter":{"sidebar_position":8},"sidebar":"tutorialSidebar","previous":{"title":"Maintaining this site","permalink":"/spec-up-t-website/docs/administrative-and-maintenance-tasks/this-site-maintainers"},"next":{"title":"F.A.Q.","permalink":"/spec-up-t-website/docs/faq"}}');var i=t(4848),r=t(8453);const o={sidebar_position:8},a="Troubleshooting",d={},l=[{value:"GitHub and API and limits",id:"github-and-api-and-limits",level:2},{value:"I am sure an external reference contains the term I am referencing, but it does not show",id:"i-am-sure-an-external-reference-contains-the-term-i-am-referencing-but-it-does-not-show",level:2},{value:"WSL2 users",id:"wsl2-users",level:2},{value:"Use Node.js versions 18+",id:"use-nodejs-versions-18",level:2}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"})}),"\n",(0,i.jsx)(n.p,{children:"Some tips in case of problems:"}),"\n",(0,i.jsx)(n.h2,{id:"github-and-api-and-limits",children:"GitHub and API and limits"}),"\n",(0,i.jsxs)(n.p,{children:["Problem: I want to look up an external reference (",(0,i.jsx)(n.em,{children:"xref"}),") but I get an error about GitHub and API and limits."]}),"\n",(0,i.jsxs)(n.p,{children:["Solution: ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/getting-started/github-token",children:"get a GitHub Token"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"i-am-sure-an-external-reference-contains-the-term-i-am-referencing-but-it-does-not-show",children:"I am sure an external reference contains the term I am referencing, but it does not show"}),"\n",(0,i.jsx)(n.p,{children:"Maybe the repository is not indexed by GitHub. Do a manual search on the term:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go to the repository"}),"\n",(0,i.jsxs)(n.li,{children:["Enter your search term in the search field that shows: \u201c",(0,i.jsx)(n.strong,{children:"Type / to search"}),"\u201d and enter."]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"If you see this:\n*\u201cThis repository's code has not been indexed yet. Try again later.\u201d *\nthe repository has not been indexed (yet)."}),"\n",(0,i.jsx)(n.p,{children:"You cannot directly trigger the indexing, but making a change by committing something helps."}),"\n",(0,i.jsx)(n.h2,{id:"wsl2-users",children:"WSL2 users"}),"\n",(0,i.jsxs)(n.p,{children:["WSL2 users are recommended to use the ",(0,i.jsx)(n.code,{children:"bash"})," option rather than ",(0,i.jsx)(n.code,{children:"PowerShell"})," in the terminal of Visual Studio Code."]}),"\n",(0,i.jsx)(n.h2,{id:"use-nodejs-versions-18",children:"Use Node.js versions 18+"}),"\n",(0,i.jsxs)(n.p,{children:["Spec-Up-T uses ",(0,i.jsx)(n.code,{children:"fetch"}),", which was ",(0,i.jsx)(n.a,{href:"https://nodejs.org/dist/latest-v18.x/docs/api/globals.html#fetch",children:"added in version 18"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"Install NVM if you haven't already. (Instructions not given here)."}),"\n",(0,i.jsx)(n.p,{children:"Then run Node.js version 18."})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(6540);const i={},r=s.createContext(i);function o(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a15a54bb.9c3ecd01.js b/assets/js/a15a54bb.1779aae3.js
similarity index 98%
rename from assets/js/a15a54bb.9c3ecd01.js
rename to assets/js/a15a54bb.1779aae3.js
index 09993870..5a13a8de 100644
--- a/assets/js/a15a54bb.9c3ecd01.js
+++ b/assets/js/a15a54bb.1779aae3.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[4456],{7013:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"getting-started/initial-configuration","title":"Initial Configuration","description":"The specs.json file, located in the root folder of your repository, specifies the configuration values used in generating your specification documents. Using the command line menu, you can configure the most important elements. The rest you can do manually.","source":"@site/docs/getting-started/initial-configuration.md","sourceDirName":"getting-started","slug":"/getting-started/initial-configuration","permalink":"/spec-up-t-website/docs/getting-started/initial-configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/getting-started/initial-configuration.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Requirements","permalink":"/spec-up-t-website/docs/getting-started/local-installation/system-requirements"},"next":{"title":"GitHub Personal Access Token (PAT)","permalink":"/spec-up-t-website/docs/getting-started/github-token"}}');var s=n(4848),o=n(8453);const r={sidebar_position:3},c="Initial Configuration",a={},p=[{value:"Create (or edit the sample) spec.json",id:"create-or-edit-the-sample-specjson",level:2}];function d(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"initial-configuration",children:"Initial Configuration"})}),"\n",(0,s.jsxs)(t.p,{children:["The ",(0,s.jsx)(t.code,{children:"specs.json"})," file, located in the root folder of your repository, specifies the configuration values used in generating your specification documents. Using the command line menu, you can configure the most important elements. The rest you can do manually."]}),"\n",(0,s.jsxs)(t.h2,{id:"create-or-edit-the-sample-specjson",children:["Create (or edit the sample) ",(0,s.jsx)(t.code,{children:"spec.json"})]}),"\n",(0,s.jsx)(t.p,{children:'If you have external glossaries in mind, then this is time to connect them to your specification and/or glossary, under "external_specs".'}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-json",children:'{\n "specs": [\n {\n "title": "Spec-Up-T Starterpack",\n "description": "Create technical specifications in markdown. Based on the original Spec-Up, extended with Terminology tooling",\n "author": "Trust over IP Foundation",\n "spec_directory": "./spec",\n "spec_terms_directory": "terms-definitions",\n "output_path": "./docs",\n "markdown_paths": [\n "spec-head.md",\n "terms-and-definitions-intro.md",\n "example-markup-in-markdown.md",\n "spec-body.md"\n ],\n "logo": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/logo.svg",\n "logo_link": "https://github.com/trustoverip/spec-up-t",\n "favicon": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/favicon.ico",\n "source": {\n "host": "github",\n "account": "trustoverip",\n "repo": "spec-up-t-starter-pack"\n },\n "external_specs": [\n {\n "external_spec": "test-1",\n "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-1/",\n "url": "https://github.com/blockchainbird/spec-up-xref-test-1",\n "terms_dir": "spec/term-definitions"\n },\n {\n "external_spec": "test-2",\n "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-2/",\n "url": "https://github.com/blockchainbird/spec-up-xref-test-2",\n "terms_dir": "spec/term-definitions"\n }\n ],\n "katex": false\n }\n ]\n}\n'})})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>c});var i=n(6540);const s={},o=i.createContext(s);function r(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[4456],{7013:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>i,toc:()=>p});const i=JSON.parse('{"id":"getting-started/initial-configuration","title":"Initial Configuration","description":"The specs.json file, located in the root folder of your repository, specifies the configuration values used in generating your specification documents. Using the command line menu, you can configure the most important elements. The rest you can do manually.","source":"@site/docs/getting-started/initial-configuration.md","sourceDirName":"getting-started","slug":"/getting-started/initial-configuration","permalink":"/spec-up-t-website/docs/getting-started/initial-configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/getting-started/initial-configuration.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":3,"frontMatter":{"sidebar_position":3},"sidebar":"tutorialSidebar","previous":{"title":"Requirements","permalink":"/spec-up-t-website/docs/getting-started/local-installation/system-requirements"},"next":{"title":"GitHub Personal Access Token (PAT)","permalink":"/spec-up-t-website/docs/getting-started/github-token"}}');var s=n(4848),o=n(8453);const r={sidebar_position:3},c="Initial Configuration",a={},p=[{value:"Create (or edit the sample) spec.json",id:"create-or-edit-the-sample-specjson",level:2}];function d(e){const t={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"initial-configuration",children:"Initial Configuration"})}),"\n",(0,s.jsxs)(t.p,{children:["The ",(0,s.jsx)(t.code,{children:"specs.json"})," file, located in the root folder of your repository, specifies the configuration values used in generating your specification documents. Using the command line menu, you can configure the most important elements. The rest you can do manually."]}),"\n",(0,s.jsxs)(t.h2,{id:"create-or-edit-the-sample-specjson",children:["Create (or edit the sample) ",(0,s.jsx)(t.code,{children:"spec.json"})]}),"\n",(0,s.jsx)(t.p,{children:'If you have external glossaries in mind, then this is time to connect them to your specification and/or glossary, under "external_specs".'}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-json",children:'{\n "specs": [\n {\n "title": "Spec-Up-T Starterpack",\n "description": "Create technical specifications in markdown. Based on the original Spec-Up, extended with Terminology tooling",\n "author": "Trust over IP Foundation",\n "spec_directory": "./spec",\n "spec_terms_directory": "terms-definitions",\n "output_path": "./docs",\n "markdown_paths": [\n "spec-head.md",\n "terms-and-definitions-intro.md",\n "example-markup-in-markdown.md",\n "spec-body.md"\n ],\n "logo": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/logo.svg",\n "logo_link": "https://github.com/trustoverip/spec-up-t",\n "favicon": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/favicon.ico",\n "source": {\n "host": "github",\n "account": "trustoverip",\n "repo": "spec-up-t-starter-pack"\n },\n "external_specs": [\n {\n "external_spec": "test-1",\n "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-1/",\n "url": "https://github.com/blockchainbird/spec-up-xref-test-1",\n "terms_dir": "spec/term-definitions"\n },\n {\n "external_spec": "test-2",\n "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-2/",\n "url": "https://github.com/blockchainbird/spec-up-xref-test-2",\n "terms_dir": "spec/term-definitions"\n }\n ],\n "katex": false\n }\n ]\n}\n'})})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>r,x:()=>c});var i=n(6540);const s={},o=i.createContext(s);function r(e){const t=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(o.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a281f58e.74ac6383.js b/assets/js/a281f58e.616775fc.js
similarity index 97%
rename from assets/js/a281f58e.74ac6383.js
rename to assets/js/a281f58e.616775fc.js
index 58315c5c..4a6fbd62 100644
--- a/assets/js/a281f58e.74ac6383.js
+++ b/assets/js/a281f58e.616775fc.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[5849],{8087:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>p,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"introduction/spec-up-and-spec-up-t","title":"Spec-Up and Spec-Up-T","description":"Spec-Up-T is originated from Spec-Up, and some of the content on this website is taken from the Spec-Up website and repo.","source":"@site/docs/introduction/spec-up-and-spec-up-t.md","sourceDirName":"introduction","slug":"/introduction/spec-up-and-spec-up-t","permalink":"/spec-up-t-website/docs/introduction/spec-up-and-spec-up-t","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/introduction/spec-up-and-spec-up-t.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"tutorialSidebar","previous":{"title":"How it came to be","permalink":"/spec-up-t-website/docs/introduction/how-it-came-to-be"},"next":{"title":"Getting Started","permalink":"/spec-up-t-website/docs/category/getting-started"}}');var i=n(4848),o=n(8453);const c={sidebar_position:5},p="Spec-Up and Spec-Up-T",r={},a=[];function d(e){const t={a:"a",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"spec-up-and-spec-up-t",children:"Spec-Up and Spec-Up-T"})}),"\n",(0,i.jsxs)(t.p,{children:["Spec-Up-",(0,i.jsx)("span",{className:"rotate",children:"T"})," is originated from ",(0,i.jsx)(t.strong,{children:"Spec-Up"}),", and some of the content on this website is taken from the ",(0,i.jsx)(t.a,{href:"https://identity.foundation/spec-up/",children:"Spec-Up website"})," and ",(0,i.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"repo"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["Spec-Up-T is an expansion of DIF's Spec-Up specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article: ",(0,i.jsx)(t.a,{href:"/spec-up-t-website/docs/introduction/how-it-came-to-be",children:"How it came to be"}),"."]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>p});var s=n(6540);const i={},o=s.createContext(i);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function p(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[5849],{8087:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>p,default:()=>u,frontMatter:()=>c,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"introduction/spec-up-and-spec-up-t","title":"Spec-Up and Spec-Up-T","description":"Spec-Up-T is originated from Spec-Up, and some of the content on this website is taken from the Spec-Up website and repo.","source":"@site/docs/introduction/spec-up-and-spec-up-t.md","sourceDirName":"introduction","slug":"/introduction/spec-up-and-spec-up-t","permalink":"/spec-up-t-website/docs/introduction/spec-up-and-spec-up-t","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/introduction/spec-up-and-spec-up-t.md","tags":[],"version":"current","lastUpdatedAt":1741105793000,"sidebarPosition":5,"frontMatter":{"sidebar_position":5},"sidebar":"tutorialSidebar","previous":{"title":"How it came to be","permalink":"/spec-up-t-website/docs/introduction/how-it-came-to-be"},"next":{"title":"Getting Started","permalink":"/spec-up-t-website/docs/category/getting-started"}}');var i=n(4848),o=n(8453);const c={sidebar_position:5},p="Spec-Up and Spec-Up-T",r={},a=[];function d(e){const t={a:"a",h1:"h1",header:"header",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.header,{children:(0,i.jsx)(t.h1,{id:"spec-up-and-spec-up-t",children:"Spec-Up and Spec-Up-T"})}),"\n",(0,i.jsxs)(t.p,{children:["Spec-Up-",(0,i.jsx)("span",{className:"rotate",children:"T"})," is originated from ",(0,i.jsx)(t.strong,{children:"Spec-Up"}),", and some of the content on this website is taken from the ",(0,i.jsx)(t.a,{href:"https://identity.foundation/spec-up/",children:"Spec-Up website"})," and ",(0,i.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"repo"}),"."]}),"\n",(0,i.jsxs)(t.p,{children:["Spec-Up-T is an expansion of DIF's Spec-Up specifically for the needs of the Trust-over-IP foundation. Read more in the elaborate motivation in this technical article: ",(0,i.jsx)(t.a,{href:"/spec-up-t-website/docs/introduction/how-it-came-to-be",children:"How it came to be"}),"."]})]})}function u(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},8453:(e,t,n)=>{n.d(t,{R:()=>c,x:()=>p});var s=n(6540);const i={},o=s.createContext(i);function c(e){const t=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function p(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:c(e.components),s.createElement(o.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/a7db03e4.b9879098.js b/assets/js/a7db03e4.41f5fdc1.js
similarity index 99%
rename from assets/js/a7db03e4.b9879098.js
rename to assets/js/a7db03e4.41f5fdc1.js
index 821634ce..adfb70a7 100644
--- a/assets/js/a7db03e4.b9879098.js
+++ b/assets/js/a7db03e4.41f5fdc1.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[9209],{3927:(e,n,i)=>{i.d(n,{Ay:()=>d,RM:()=>r});var s=i(4848),t=i(8453);const r=[];function o(e){const n={code:"code",pre:"pre",...(0,t.R)(),...e.components};return(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-sh",children:" ,---. . . --.--\n `---.,---.,---.,---. | |,---. |\n || ||---'| ---| || |--- |\n `---'|---'`---'`---' `---'|---' `\n | |\n\n\n Please choose one of the following options:\n\n [0] Add content\n [1] Render specification\n [2] Export to PDF\n [3] Collect external references (cache, faster)\n [4] Collect external references (no cache, slower)\n [5] Add, remove or view xref source\n [6] Configure\n [7] Open documentation website\n [8] Freeze specification\n [Q] Quit\n\n An xref is a reference to another repository.\n\n Enter your choice:\n"})})}function d(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},7412:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>p,frontMatter:()=>d,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"developer-documentation/code-overview/workflow-abstraction","title":"Workflow abstraction","description":"Starting point","source":"@site/docs/developer-documentation/code-overview/workflow-abstraction.md","sourceDirName":"developer-documentation/code-overview","slug":"/developer-documentation/code-overview/workflow-abstraction","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/workflow-abstraction","draft":false,"unlisted":false,"editUrl":"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developer-documentation/code-overview/workflow-abstraction.md","tags":[],"version":"current","lastUpdatedAt":1741099879000,"frontMatter":{},"sidebar":"tutorialSidebar","previous":{"title":"Starterpack (via NPX)","permalink":"/spec-up-t-website/docs/developer-documentation/code-overview/files-directories/starterpack"},"next":{"title":"Local test environment","permalink":"/spec-up-t-website/docs/developer-documentation/local-test-environment"}}');var t=i(4848),r=i(8453),o=i(3927);const d={},c="Workflow abstraction",a={},l=[{value:"Starting point",id:"starting-point",level:2},...o.RM,{value:"End result",id:"end-result",level:2},{value:"Menu option [0] Add content",id:"menu-option-0-add-content",level:2},{value:"Menu option [1] Render specification",id:"menu-option-1-render-specification",level:2},{value:"create-term-index.js",id:"create-term-indexjs",level:3},{value:"insert-term-index.js",id:"insert-term-indexjs",level:3},{value:"create-versions-index.js",id:"create-versions-indexjs",level:3},{value:"prepare-tref.js",id:"prepare-trefjs",level:3},{value:"fix-markdown-files.js",id:"fix-markdown-filesjs",level:3},{value:"index.js",id:"indexjs",level:3},{value:"Menu option [8] Freeze specification",id:"menu-option-8-freeze-specification",level:2}];function h(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"workflow-abstraction",children:"Workflow abstraction"})}),"\n",(0,t.jsx)(n.h2,{id:"starting-point",children:"Starting point"}),"\n",(0,t.jsxs)(n.p,{children:["We start with a collection of markdown files containing terms and definitions. We want to create a \u201cspecification\u201d from these markdownfiles. This is going to be an ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"index.html"})})," file."]}),"\n",(0,t.jsxs)(n.p,{children:["User Entry ",(0,t.jsx)(n.strong,{children:"Point"})," is a Command Line Menu:"]}),"\n",(0,t.jsx)(o.Ay,{}),"\n",(0,t.jsx)(n.h2,{id:"end-result",children:"End result"}),"\n",(0,t.jsxs)(n.p,{children:["The end result is an ",(0,t.jsx)(n.strong,{children:(0,t.jsx)(n.code,{children:"index.html"})})," file that is \u201cself containing\u201d, in this case meaning that it has all the styling (CSS) and behaviour (JS) and data (a JS variable) inside."]}),"\n",(0,t.jsxs)(n.h2,{id:"menu-option-0-add-content",children:["Menu option ",(0,t.jsx)(n.code,{children:"[0] Add content"})]}),"\n",(0,t.jsx)(n.p,{children:"Shows simple instructions on how to add content."}),"\n",(0,t.jsxs)(n.h2,{id:"menu-option-1-render-specification",children:["Menu option ",(0,t.jsx)(n.code,{children:"[1] Render specification"})]}),"\n",(0,t.jsx)(n.p,{children:"Steps:\n|"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 BEGIN \u2013"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 1 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"create-term-indexjs",children:(0,t.jsx)(n.code,{children:"create-term-index.js"})}),"\n",(0,t.jsxs)(n.p,{children:["Read all the user-created ",(0,t.jsx)(n.strong,{children:"term files"})," (markdown)."]}),"\n",(0,t.jsxs)(n.p,{children:["Make an ordered list (JSON) of all the names of the terms files (\u201c",(0,t.jsx)(n.strong,{children:"term index"}),"\u201d)."]}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2193"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 2 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"insert-term-indexjs",children:(0,t.jsx)(n.code,{children:"insert-term-index.js"})}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Use content of ",(0,t.jsx)(n.code,{children:"specs.json"})," (the ",(0,t.jsx)(n.strong,{children:"user config file"})," )"]}),"\n",(0,t.jsxs)(n.li,{children:["Insert ",(0,t.jsx)(n.strong,{children:"term index"})," in this content"]}),"\n",(0,t.jsxs)(n.li,{children:["Create a ",(0,t.jsx)(n.code,{children:"specs-generated.json"})," (",(0,t.jsx)(n.strong,{children:"system config file"}),") from this content."]}),"\n"]}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2193"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 3 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"create-versions-indexjs",children:(0,t.jsx)(n.code,{children:"create-versions-index.js"})}),"\n",(0,t.jsx)(n.p,{children:"Create a directory with a version index (if it does not exist yet)."}),"\n",(0,t.jsx)(n.p,{children:"This page lists all available snapshots of this Spec-Up-T specification"}),"\n",(0,t.jsx)(n.p,{children:"#version #snapshot"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2193"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 4 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"prepare-trefjs",children:(0,t.jsx)(n.code,{children:"prepare-tref.js"})}),"\n",(0,t.jsxs)(n.p,{children:["Prepare the markdown files that contain '",(0,t.jsx)(n.strong,{children:"[[tref]]"}),"'s as a definition. A '",(0,t.jsx)(n.strong,{children:"[[tref]]"}),"' is a term defined in another (\u201cremote\u201d or \u201cexternal\u201d) specification. The definition (already locally stored in local JSON) is inserted in the file."]}),"\n",(0,t.jsx)(n.p,{children:"The definition is prepended by an html comment stating that everything below is inserted and can safely be removed."}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2193"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 5 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"fix-markdown-filesjs",children:(0,t.jsx)(n.code,{children:"fix-markdown-files.js"})}),"\n",(0,t.jsx)(n.p,{children:"Fix the markdown in the term files."}),"\n",(0,t.jsxs)(n.p,{children:["One blank line between paragraphs, prepend ",(0,t.jsx)(n.code,{children:"~"})," to lines, etc"]}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2193"}),"\n",(0,t.jsx)("div",{className:"size-big-centered",children:"\u2013 6 \u2013"}),"\n",(0,t.jsx)(n.h3,{id:"indexjs",children:(0,t.jsx)(n.code,{children:"index.js"})}),"\n",(0,t.jsxs)(n.p,{children:["Create a
-
+
+
This section is for topics related to system management, upkeep, and tasks that require administrative privileges.
This section is for topics related to system management, upkeep, and tasks that require administrative privileges.