Skip to content

Commit

Permalink
docs about history of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
iJungleboy committed Dec 12, 2024
1 parent 3565b5a commit b9b23a8
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 3 deletions.
29 changes: 28 additions & 1 deletion docs-src/pages/abyss/contribute/docs/implementation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ It's especially useful when the SVG uses `currentColor` in it's own CSS.

Changed: 2024-12-10, `@iJungleboy`

#### Created Attribution System

We created an attribution system to show who wrote which part of the documentation.

Changed: ca. 2024-12-05, `@iJungleboy`

#### Standardized Entire Setup

We put all customizations and docs-instructions in the `2sxc` docs only,
Expand All @@ -94,4 +100,25 @@ Implementation:
1. Everything shared is now in `/templates/shared-global`
1. The `/templates/[project]/src` is now the only place for project-specific customizations

Changed: 2024-12-09, `@iJungleboy`, `@tvatavuk`
Changed: 2024-12-05, `@iJungleboy`, `@tvatavuk`


#### Added Gallery Feature

We created the `<div gallery="name"><!-- img list --></div>` feature to create galleries
with previews etc.

Changed: ca. 2024-12-01, `@iJungleboy`

#### Added Lightbox with Fancybox

We added the Fancybox lightbox to the system, so that images can be opened in a lightbox.

Changed: ca. 2024-11, `@iJungleboy`


#### Added Razor/Blazor Syntax Coloring

We added the Razor/Blazor syntax coloring to the system, so that code can be colored.

Changed: ca. 2024-06, `@tvatavuk`
15 changes: 14 additions & 1 deletion docs/abyss/contribute/docs/implementation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,9 @@ <h4 id="added-svg-helpers-for-colored-logos">Added SVG helpers for colored logos
<li><code>/templates/shared-global/src/scripts/svgs/svg-importer.ts</code></li>
</ul>
<p>Changed: 2024-12-10, <code>@iJungleboy</code></p>
<h4 id="created-attribution-system">Created Attribution System</h4>
<p>We created an attribution system to show who wrote which part of the documentation.</p>
<p>Changed: ca. 2024-12-05, <code>@iJungleboy</code></p>
<h4 id="standardized-entire-setup">Standardized Entire Setup</h4>
<p>We put all customizations and docs-instructions in the <code>2sxc</code> docs only,
to consolidate everything from 2sxc, Oqtane, RazorBlade and cre8magic.</p>
Expand All @@ -188,7 +191,17 @@ <h4 id="standardized-entire-setup">Standardized Entire Setup</h4>
<li>Everything shared is now in <code>/templates/shared-global</code></li>
<li>The <code>/templates/[project]/src</code> is now the only place for project-specific customizations</li>
</ol>
<p>Changed: 2024-12-09, <code>@iJungleboy</code>, <code>@tvatavuk</code></p>
<p>Changed: 2024-12-05, <code>@iJungleboy</code>, <code>@tvatavuk</code></p>
<h4 id="added-gallery-feature">Added Gallery Feature</h4>
<p>We created the <code>&lt;div gallery=&quot;name&quot;&gt;&lt;!-- img list --&gt;&lt;/div&gt;</code> feature to create galleries
with previews etc.</p>
<p>Changed: ca. 2024-12-01, <code>@iJungleboy</code></p>
<h4 id="added-lightbox-with-fancybox">Added Lightbox with Fancybox</h4>
<p>We added the Fancybox lightbox to the system, so that images can be opened in a lightbox.</p>
<p>Changed: ca. 2024-11, <code>@iJungleboy</code></p>
<h4 id="added-razorblazor-syntax-coloring">Added Razor/Blazor Syntax Coloring</h4>
<p>We added the Razor/Blazor syntax coloring to the system, so that code can be colored.</p>
<p>Changed: ca. 2024-06, <code>@tvatavuk</code></p>

</article>

Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
"abyss/contribute/docs/implementation/index.html": {
"href": "abyss/contribute/docs/implementation/index.html",
"title": "Docs: Technical Implementation | 2sxc 18 for Dnn and Oqtane",
"keywords": "Tip The docs as explained here are used in multiple projects, but documented only once for better maintenance. When applying this to other projects, remember that some things such as the name, repository, or paths are a bit different. \uD83C\uDF34 2sxc: Docs Repo, Docs Live \uD83E\uDE78 Oqtane: Docs Repo, Docs Live ♾️ cre8magic: Docs Repo, Docs Live Docs: Technical Implementation Warning This is a technical documentation about how the documentation system works. It helps the core team understand how to maintain and enhance the documentation system. It's not meant for most contributors, as it's too technical. Basics The documentation is built with DocFX. When compiling, it will take the C# code and the markdown files and merge them together... ...and create a static HTML documentation which can be hosted anywhere - often on GitHub pages. The Parts that Make it Work Since this is a large documentation it needs a bit more than just the standard DocFX setup. Here is an overview as to what is really implemented: DocFX will build everything based on the configuration in docfx.json, filterConfig.yml and xrefmap.yml ➡️ Configuration C# Code Docs generation and Merging with additional docs is very sophisticated. ➡️ C# Code Docs JavaScript Code Docs generation and Merging with additional docs is a beast! ➡️ JavaScript Code Docs The Templates generate everything, add JS and much more ➡️ Templates We have some custom magic to improve the C# API TOC ➡️ TOC Customizations The /templates/[project]/src has TypeScript and SASS which is compiled with WebPack to the /public folder ➡️ see TypeScript, CSS, WebPack Customizations We implemented a special Permalink-System TODO: @iJungleboy Most projects also support version-switching, so you can switch between versions of the documentation TODO: @iJungleboy History of this Docs Setup 2024 Note: we only started documenting this in 2024-12, so it's incomplete. Reduced Time-To-Redirect on XREF to 1 Second Previously the time to redirect was 3 seconds. We reduced it to 1 second. /templates/shared-global/src/scripts/xref/xref.ts Changed: 2024-12-12, @iJungleboy Made API-Docs TOC Sidebar not Wrap Added the api-toc-sidebar-menus.scss to prevent the API-Docs TOC from wrapping. /templates/shared-global/src/styles/api-toc-sidebar-menu.scss /templates/shared-global/src/styles/_index.scss Changed: 2024-12-12, @iJungleboy Added SVG helpers for colored logos Added some JavaScripts to inline SVGs on img tags with the class svg. This helps for both the logo and images added like this, so that they will be inlined and behave according to the CSS. It's especially useful when the SVG uses currentColor in it's own CSS. /templates/shared-global/src/scripts/svgs/svg-importer.ts Changed: 2024-12-10, @iJungleboy Standardized Entire Setup We put all customizations and docs-instructions in the 2sxc docs only, to consolidate everything from 2sxc, Oqtane, RazorBlade and cre8magic. Implementation: Everything shared is now in /templates/shared-global The /templates/[project]/src is now the only place for project-specific customizations Changed: 2024-12-09, @iJungleboy, @tvatavuk"
"keywords": "Tip The docs as explained here are used in multiple projects, but documented only once for better maintenance. When applying this to other projects, remember that some things such as the name, repository, or paths are a bit different. \uD83C\uDF34 2sxc: Docs Repo, Docs Live \uD83E\uDE78 Oqtane: Docs Repo, Docs Live ♾️ cre8magic: Docs Repo, Docs Live Docs: Technical Implementation Warning This is a technical documentation about how the documentation system works. It helps the core team understand how to maintain and enhance the documentation system. It's not meant for most contributors, as it's too technical. Basics The documentation is built with DocFX. When compiling, it will take the C# code and the markdown files and merge them together... ...and create a static HTML documentation which can be hosted anywhere - often on GitHub pages. The Parts that Make it Work Since this is a large documentation it needs a bit more than just the standard DocFX setup. Here is an overview as to what is really implemented: DocFX will build everything based on the configuration in docfx.json, filterConfig.yml and xrefmap.yml ➡️ Configuration C# Code Docs generation and Merging with additional docs is very sophisticated. ➡️ C# Code Docs JavaScript Code Docs generation and Merging with additional docs is a beast! ➡️ JavaScript Code Docs The Templates generate everything, add JS and much more ➡️ Templates We have some custom magic to improve the C# API TOC ➡️ TOC Customizations The /templates/[project]/src has TypeScript and SASS which is compiled with WebPack to the /public folder ➡️ see TypeScript, CSS, WebPack Customizations We implemented a special Permalink-System TODO: @iJungleboy Most projects also support version-switching, so you can switch between versions of the documentation TODO: @iJungleboy History of this Docs Setup 2024 Note: we only started documenting this in 2024-12, so it's incomplete. Reduced Time-To-Redirect on XREF to 1 Second Previously the time to redirect was 3 seconds. We reduced it to 1 second. /templates/shared-global/src/scripts/xref/xref.ts Changed: 2024-12-12, @iJungleboy Made API-Docs TOC Sidebar not Wrap Added the api-toc-sidebar-menus.scss to prevent the API-Docs TOC from wrapping. /templates/shared-global/src/styles/api-toc-sidebar-menu.scss /templates/shared-global/src/styles/_index.scss Changed: 2024-12-12, @iJungleboy Added SVG helpers for colored logos Added some JavaScripts to inline SVGs on img tags with the class svg. This helps for both the logo and images added like this, so that they will be inlined and behave according to the CSS. It's especially useful when the SVG uses currentColor in it's own CSS. /templates/shared-global/src/scripts/svgs/svg-importer.ts Changed: 2024-12-10, @iJungleboy Created Attribution System We created an attribution system to show who wrote which part of the documentation. Changed: ca. 2024-12-05, @iJungleboy Standardized Entire Setup We put all customizations and docs-instructions in the 2sxc docs only, to consolidate everything from 2sxc, Oqtane, RazorBlade and cre8magic. Implementation: Everything shared is now in /templates/shared-global The /templates/[project]/src is now the only place for project-specific customizations Changed: 2024-12-05, @iJungleboy, @tvatavuk Added Gallery Feature We created the <div gallery=\"name\"><!-- img list --></div> feature to create galleries with previews etc. Changed: ca. 2024-12-01, @iJungleboy Added Lightbox with Fancybox We added the Fancybox lightbox to the system, so that images can be opened in a lightbox. Changed: ca. 2024-11, @iJungleboy Added Razor/Blazor Syntax Coloring We added the Razor/Blazor syntax coloring to the system, so that code can be colored. Changed: ca. 2024-06, @tvatavuk"
},
"abyss/contribute/docs/implementation/javascript-code.html": {
"href": "abyss/contribute/docs/implementation/javascript-code.html",
Expand Down

0 comments on commit b9b23a8

Please sign in to comment.