Fix the comment system

mbeddr · Jul 12, 2024 · 471ae71 · 471ae71
1 parent 9d44157
commit 471ae71
Show file tree

Hide file tree

Showing 211 changed files with 366 additions and 45 deletions.
diff --git a/src/doc/docs/about/editing_this_guide.md b/src/doc/docs/about/editing_this_guide.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - guide
 ---

diff --git a/src/doc/docs/about/original_authors.md b/src/doc/docs/about/original_authors.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/aspects/accessory_models.md b/src/doc/docs/aspects/accessory_models.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Accessory Models
 hide:
 - toc

diff --git a/src/doc/docs/aspects/actions.md b/src/doc/docs/aspects/actions.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Action Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/behavior.md b/src/doc/docs/aspects/behavior.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Behavior Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/constraints.md b/src/doc/docs/aspects/constraints.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Constraints Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/dataflow.md b/src/doc/docs/aspects/dataflow.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Dataflow Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/documentation.md b/src/doc/docs/aspects/documentation.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Documentation Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/editor.md b/src/doc/docs/aspects/editor.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Editor Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/feedback.md b/src/doc/docs/aspects/feedback.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Feedback Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/findusages.md b/src/doc/docs/aspects/findusages.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: FindUsages Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/generator.md b/src/doc/docs/aspects/generator.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Generator Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/intentions.md b/src/doc/docs/aspects/intentions.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Intentions Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/listener.md b/src/doc/docs/aspects/listener.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Listener Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/migration.md b/src/doc/docs/aspects/migration.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Migration Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/plugin.md b/src/doc/docs/aspects/plugin.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Plugin Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/polyfun.md b/src/doc/docs/aspects/polyfun.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Polymorphic Functions Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/refactorings.md b/src/doc/docs/aspects/refactorings.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Refactorings Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/scripts.md b/src/doc/docs/aspects/scripts.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Scripts Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/structure.md b/src/doc/docs/aspects/structure.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Structure Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/test.md b/src/doc/docs/aspects/test.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Test Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/textgen.md b/src/doc/docs/aspects/textgen.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: TextGen Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/transformations.md b/src/doc/docs/aspects/transformations.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Transformations Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/typesystem.md b/src/doc/docs/aspects/typesystem.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Typ System Aspect
 tags:
 - aspect

diff --git a/src/doc/docs/aspects/vcs.md b/src/doc/docs/aspects/vcs.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: VCS Aspect
 hide:
 - toc

diff --git a/src/doc/docs/aspects/virtualinterfaces.md b/src/doc/docs/aspects/virtualinterfaces.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 title: Virtual Interfaces Aspect
 hide:
 - toc

diff --git a/src/doc/docs/build/advanced_github_workflow.md b/src/doc/docs/build/advanced_github_workflow.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 The following workflow suits small projects and projects with hundreds of developers. This guide assumes that you host the project on GitHub and that the CI pipeline also runs on GitHub. Additionally, one or more teams work on the project and have some form of [agile software development](https://www.wikiwand.com/en/Agile_software_development) implemented.
 New feature/bug fixes are developed based on a [ticket](https://www.vollcom-digital.com/blog/digital-transformation/how-to-write-an-agile-ticket/) system.
 

diff --git a/src/doc/docs/build/ci.md b/src/doc/docs/build/ci.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - infrastructure
 ---

diff --git a/src/doc/docs/build/command_line_tool.md b/src/doc/docs/build/command_line_tool.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/build/git.md b/src/doc/docs/build/git.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - infrastructure
 ---

diff --git a/src/doc/docs/build/gradle.md b/src/doc/docs/build/gradle.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - infrastructure
 ---

diff --git a/src/doc/docs/build/index.md b/src/doc/docs/build/index.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - mps_language
 - build

diff --git a/src/doc/docs/build/teamcity.md b/src/doc/docs/build/teamcity.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 ---

diff --git a/src/doc/docs/clean_code/java/index.md b/src/doc/docs/clean_code/java/index.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - java
 - best_practise

diff --git a/src/doc/docs/clean_code/java/java_style_guide.md b/src/doc/docs/clean_code/java/java_style_guide.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/clean_code/java/programming_principles.md b/src/doc/docs/clean_code/java/programming_principles.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/clean_code/mps/deprecation.md b/src/doc/docs/clean_code/mps/deprecation.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/clean_code/mps/index.md b/src/doc/docs/clean_code/mps/index.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 This document lists some recommendations for code written in MPS. For a general introduction to code smells, go to [Code Smells | Coding Horror](https://blog.codinghorror.com/code-smells/) and [How To Write Unmaintainable Code](https://web.archive.org/web/20171224114025id_/https://www.thc.org/root/phun/unmaintain.html). Clean code has many benefits. [Clean Code: Writing maintainable, readable, and testable code | https://blogs.sap.com/](https://blogs.sap.com/2022/12/21/clean-code-writing-maintainable-readable-and-testable-code/) describes those benefits.
 
 

diff --git a/src/doc/docs/clean_code/mps/readability_maintainability.md b/src/doc/docs/clean_code/mps/readability_maintainability.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/home/console.md b/src/doc/docs/home/console.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/home/debugging.md b/src/doc/docs/home/debugging.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - troubleshooting
 ---

diff --git a/src/doc/docs/home/external_files_and_tools.md b/src/doc/docs/home/external_files_and_tools.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - files
 - tools

diff --git a/src/doc/docs/home/general.md b/src/doc/docs/home/general.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/home/overcoming_obstacles/debugging_problems.md b/src/doc/docs/home/overcoming_obstacles/debugging_problems.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # [Debugging Problems](https://pythonprinciples.com/blog/getting-unstuck/#debugging-problems)
 
 Different kinds of problems can occur in MPS. Some of them are bugs that you have to fix. Other issues might be unfixable or caused by an unusual approach to tackling a problem (e.g., [accessing a project instance](accessing_the_project.md) from unsupported places). For debugging purposes, you can add log statements to the code, execute tests, analyze stack traces, run code on the MSP console, or use [remote debugging](https://specificlanguages.com/articles/debugging/).

diff --git a/src/doc/docs/home/overcoming_obstacles/general_tips.md b/src/doc/docs/home/overcoming_obstacles/general_tips.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # General Tips
 
 No matter what type of challenge you face, some tips always help you to make progress or remove your blocker.

diff --git a/src/doc/docs/home/overcoming_obstacles/overcoming_obstacles.md b/src/doc/docs/home/overcoming_obstacles/overcoming_obstacles.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # Overcoming Obstacles
 
 You probably already read the [troubleshooting guide](trouble_shooting_guide.md), [Finding your way out | MPS User's Guide](https://www.jetbrains.com/help/mps/finding-your-way-out.html) and [Debugging](debugging.md) but you still need help with an issue.

diff --git a/src/doc/docs/home/overcoming_obstacles/syntax_problems.md b/src/doc/docs/home/overcoming_obstacles/syntax_problems.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 ## [Syntax Problems in the Editor](https://pythonprinciples.com/blog/getting-unstuck/#syntax-problems)
 
 Caused by the projectional editing approach, syntax problems don’t exist in MPS. Sometimes it takes work to enter text, though. A general technique that often works is to search for instances of a concept in the current project or globally to figure out how it works if there is no documentation.

diff --git a/src/doc/docs/home/overcoming_obstacles/thinking_problems.md b/src/doc/docs/home/overcoming_obstacles/thinking_problems.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # [Thinking Problems](https://pythonprinciples.com/blog/getting-unstuck/#thinking-problems)
 
 You can do it without much thought when you have an easy coding problem. When you have to deal with a new topic that you are unfamiliar with

diff --git a/src/doc/docs/home/overcoming_obstacles/understanding_the_problem.md b/src/doc/docs/home/overcoming_obstacles/understanding_the_problem.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # [Understanding the Problem](https://pythonprinciples.com/blog/getting-unstuck/#incomplete-understanding)
 
 Not understanding the problem 100% is often the problem. Read the task/issue several times until you can explain it to someone else. If you don't fully

diff --git a/src/doc/docs/home/performance.md b/src/doc/docs/home/performance.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 alias: performance
 ---
 

diff --git a/src/doc/docs/home/platform_specific_bugs.md b/src/doc/docs/home/platform_specific_bugs.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - windows
 - mac

diff --git a/src/doc/docs/home/plugins.md b/src/doc/docs/home/plugins.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 ---

diff --git a/src/doc/docs/home/rcp.md b/src/doc/docs/home/rcp.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/home/trouble_shooting_guide.md b/src/doc/docs/home/trouble_shooting_guide.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - troubleshooting
 - settings

diff --git a/src/doc/docs/home/visual_guide.md b/src/doc/docs/home/visual_guide.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - ui
 ---

diff --git a/src/doc/docs/index.md b/src/doc/docs/index.md
@@ -1,4 +1,5 @@
 ---
+comments: false
 title: Home
 hide:
 - toc

diff --git a/src/doc/docs/language_reference/index.md b/src/doc/docs/language_reference/index.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # IETS3.opensource Language Reference (WIP)
 
 This is a WIP language reference, currently under review on [GitHub](https://github.com/mbeddr/mbeddr.core/pull/2275).

diff --git a/src/doc/docs/language_reference/org.iets3.core.expr.base.md b/src/doc/docs/language_reference/org.iets3.core.expr.base.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # org.iets3.core.expr.base
 
 ---

diff --git a/src/doc/docs/language_reference/org.iets3.core.expr.toplevel.md b/src/doc/docs/language_reference/org.iets3.core.expr.toplevel.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 # org.iets3.core.expr.toplevel
 
 ---

diff --git a/src/doc/docs/languages/baselanguage.md b/src/doc/docs/languages/baselanguage.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - baselanguage
 ---

diff --git a/src/doc/docs/languages/cell_layout.md b/src/doc/docs/languages/cell_layout.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - mps_extensions
 ---

diff --git a/src/doc/docs/languages/double_dispatch.md b/src/doc/docs/languages/double_dispatch.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 hide:
 - toc
 tags:

diff --git a/src/doc/docs/languages/kernelf/kernelf.md b/src/doc/docs/languages/kernelf/kernelf.md
@@ -1,4 +1,5 @@
 ---
+comments: true
 tags:
 - iets3
 alias: kernelf
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
     ---
+    comments: true
     tags:
     - guide
     ---
@@ Expand Down @@