7e21093e932d8eddb2c47ce129bfefabda66c74d
11
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
|
3e2f9d0648 |
Blog/quality check (#122)
* Add blog post template for quality improvement initiative (Refs #121) * Update YAML frontmatter for 2025-05-25-sequential-thinking-revolution.md (Refs #121) * Update YAML frontmatter for 2025-06-04-ki-fuer-einsteiger-live-erleben.md (Refs #121) * Corrected YAML frontmatter and flagged for translation for 2025-05-25-sequential-thinking-revolution.md (Refs #121) * Corrected YAML frontmatter and flagged for translation for 2025-06-04-ki-fuer-einsteiger-live-erleben.md (Refs #121) * Finalize 2025-05-25-sequential-thinking-revolution.md (Refs #121) * Finalize 2025-06-04-ki-fuer-einsteiger-live-erleben.md (Refs #121) * Translated 2025-05-25-sequential-thinking-revolution.md to German (Refs #121) * Fix: Exclude blog-post-template.md from MkDocs blog plugin (Refs #ISSUE_NUMBER) * Fix: Revert mkdocs.yml exclude and fix typo in redirects (Refs #ISSUE_NUMBER) * Move blog-post-template.md to docs/templates/blog (Refs #ISSUE_NUMBER) * Delete docs/blog/posts/blog-post-template.md Signed-off-by: Michael Wegener <mw@satware.com> * Fix: Correctly decode and update blog-post-template.md (Refs #ISSUE_NUMBER) * Fix: Correct typo in mkdocs.yml redirect_maps (Refs #ISSUE_NUMBER) * Fix: Add fetch-depth: 0 to checkout action in deploy-preview.yml (Refs #ISSUE_NUMBER) * Fix: Add fetch-depth: 0 to checkout action in deploy-live.yml (Refs #ISSUE_NUMBER) --------- Signed-off-by: Michael Wegener <mw@satware.com> Co-authored-by: Jane Alesi <ja@satware.ai> |
||
|
|
af4bee0e4d |
feat: Add comprehensive issue reporting and contribution guidelines (#105)
* feat: Add issue reporting guidelines to README.md
- Add dedicated "🐛 Issue Reporting" section with clear instructions
- Direct users to main repository issue tracker
- Include template for issue reporting with required information
- Improve project transparency and user support workflow
* fix: Update repository references and add issue reporting guidelines
- Fix incorrect repository reference (satwareAG-ironMike → satwareAG)
- Add comprehensive issue reporting section
- Clarify workflow between forks and main repository
- Improve contribution process documentation
* feat: Add GitHub issue templates for better issue management
- Add bug report template with structured fields
- Provide clear guidance for issue reporting
- Improve issue quality and processing efficiency
* feat: Add feature request template
- Add structured feature request template
- Include sections for use case, implementation details, and alternatives
- Improve feature planning and discussion process
* feat: Add content issue template
- Add template for content-related issues (typos, outdated info, etc.)
- Provide specific fields for content corrections
- Improve content quality maintenance process
* feat: Add issue template configuration
- Configure issue template chooser with clear options
- Add contact links for support and security
- Improve issue routing and user guidance
* feat: Add pull request template
- Add comprehensive PR template with structured sections
- Include checklist for quality assurance
- Improve code review and integration process
|
||
|
|
7cf43df29c |
Replace mkdocs-lightbox with mkdocs-glightbox in deploy-live.yml for plugin update. (#102)
|
||
|
|
887fe536d6 |
Fix/local development (#101)
* **Remove Python SCSS compiler and development script** - Deleted `compile_scss.py` and `dev.sh` scripts to clean up unused SCSS compilation and local development workflow. - Streamlining project by removing legacy Python-based tooling. Clear shift toward alternative CSS build processes in workflows. * Migrate SCSS compilation to Python-based workflow and simplify Dockerfile - Replaced Node.js SCSS tools with libsass and introduced `scss_watcher.py` for automated SCSS compilation during development. - Updated Dockerfile to use Python-based dependencies and removed redundant npm configuration. - Cleaned up `package.json`, `requirements.txt`, and outdated scripts to streamline the project. - Enhanced development workflow with a lightweight Python-based approach. * Replace `python -m sass` with `pysassc` for SCSS compilation in development scripts * **Refactor and streamline MkDocs workflows, footer, and blog structure** - Removed outdated `deploy-preview-fix.yml` and `deploy-test.yml` workflows for cleanup. - Enhanced `deploy-preview.yml`: - Expanded branch triggers to include `build/**`, `test/**`, and `preview/**`. - Improved `site_url` logic by standardizing URL formatting. - Updated `mkdocs.yml` navigation to use consistent `index.md` file naming. - Simplified footer template to use relative paths for internal links (e.g., `impressum/`, `datenschutz/`). - Adjusted `mkdocs.sh` to ensure SCSS watcher includes `overrides`. - Deleted outdated `Sequential Thinking` blog and branch documentation for better maintenance. * Update to Python 3.13 and streamline MkDocs workflows - Upgraded Dockerfile base image to `python:3.13-slim-bullseye` for consistency with the latest Python version. - Consolidated MkDocs and plugin installation steps in `deploy-preview.yml`. - Replaced Node.js SCSS tools with Python `pysassc` for CSS build process, removing unnecessary npm steps. * Replace `mkdocs-lightbox` with `mkdocs-glightbox` and improve CSS build step in GitHub Actions workflow - Updated `deploy-preview.yml` to switch from `mkdocs-lightbox` to `mkdocs-glightbox` for better compatibility and features. - Enhanced CSS build logic to create the target directory (`docs/assets/css`) if it does not exist, ensuring a smoother workflow execution. * Streamline deploy workflows and enhance CSS build process - Added repository-specific condition to `deploy-live.yml` for improved workflow targeting. - Consolidated MkDocs and plugin installation steps in `deploy-live.yml` to remove redundant tasks. - Enhanced CSS build step to ensure target directory creation (`mkdir -p docs/assets/css`) in both workflows. |
||
|
|
0d1de78799 |
Fix/64 logo navi fehlt bei mobile ansicht auf ipad bspw quer (#3)
* Update .gitignore to include custom.css.map Added a reference to custom.css.map to prevent it from being tracked by Git. This helps avoid committing autogenerated files and keeps the repository clean. * Fix layout issues for iPad and tablet landscape view Updated responsive styles to ensure proper visibility and alignment of header elements and navigation on devices with widths between 768px and 1220px. Adjusted logo, spacing, font sizes, and layout to improve usability and appearance. Disabled the hamburger menu to avoid conflicts in this viewport range. * Fix layout issues for iPad and tablet landscape view Updated responsive styles to ensure proper visibility and alignment of header elements and navigation on devices with widths between 768px and 1220px. Adjusted logo, spacing, font sizes, and layout to improve usability and appearance. Disabled the hamburger menu to avoid conflicts in this viewport range. * Add workflow_dispatch trigger to preview workflows Enable manual execution for preview deployment workflows by adding the `workflow_dispatch` trigger. This allows users to start the workflows manually when necessary, improving flexibility and control. * Set default font to "Assistant" in base.scss Removed an unnecessary comment and ensured the root uses "Assistant" as the default font. This improves code clarity while maintaining consistent styling. --------- Co-authored-by: Tim Friedrich Weber <tfw@satware.com> |
||
|
|
f8b7ea2989 |
Neuer Blog-Beitrag: Wie moderne LLMs wirklich denken (#58)
* Neuer Blog-Beitrag: Wie moderne LLMs wirklich denken * Update blog post to improve formatting * Add modified workflow file to fix deployment * Add README to blog post directory * Fix YAML front matter quotes syntax * Update MkDocs config to exclude README.md from blog posts * Delete docs/blog/posts/README.md Signed-off-by: Jane Alesi <ja@satware.ai> * Fix Mermaid diagram styling for dark mode * Add Jane Alesi as additional author --------- Signed-off-by: Jane Alesi <ja@satware.ai> |
||
|
|
8cb0cb17d6 | fix preview | ||
|
|
042b44ccbc |
Blog/2025 05 20 test blog post (#53)
* Remove unused font-face definitions from stylesheets The `fonts.scss` file defining `Assistant` font-face rules has been deleted as it was no longer in use. This cleanup reduces unnecessary assets and improves maintainability. * Fix npm script command in blog preview workflow Replaced `npm scss:build` with the correct `npm run scss:build` command in the GitHub Actions workflow. This ensures the SCSS build step executes properly during site generation. * Update blog preview workflow to use mkdocs gh-deploy Replaces the GitHub Pages action with `mkdocs gh-deploy` for deploying previews. Simplifies the workflow configuration and reduces dependencies. * Update `site_url` logic and fix URL format consistency Simplified the `site_url` handling in the workflow by removing branch-specific URL construction. Additionally, ensured the main URL in `mkdocs.yml` uses a consistent trailing slash. This enhances clarity and maintains uniformity in URL formatting. * Set `use_directory_urls` in mkdocs.yml directly. Removed redundant script lines for configuring `use_directory_urls` in the workflow file. This simplifies deployment logic by directly defining the configuration in the mkdocs.yml file. * Remove unnecessary CSS source map file Deleted `custom.css.map` as it is not required for production. Removing it helps reduce clutter and keeps the repository clean. * Add support for 'satware.ai' as a homepage path Updated body-classes.js to treat 'satware.ai' as a homepage path by adding the 'home' class to the body element. This ensures correct behavior for both empty paths and specific developer GitHub Pages. * Simplify FAQ and navigation structure. Renamed `faq.md` to `index.md` for consistency and updated navigation links in `mkdocs.yml` to use folder paths directly. Adjusted `main.html` to clean up formatting with additional line breaks. * Update footer links to use relative paths Replaced absolute paths with relative paths for internal footer links to ensure consistency and improve maintainability. External links remain unchanged. * Fix relative URL for Jane Alesi's team page in authors file Updated the URL path for Jane Alesi to ensure correct navigation to her team page. This fixes a broken link caused by an incorrect relative URL. * Update footer links and enhance blog post on website relaunch Updated footer links to utilize dynamic `config.site_url` for consistent URL routing. Enhanced the blog post for better readability, showcasing the MkDocs implementation, GitHub integration, and use of Mermaid diagrams. * Update footer link and simplify satWay documentation Replaced the "Blog" link in the footer with "satWay Prinzipien" and refined the satWay documentation by removing overly detailed content about Jane Alesi. Additionally, added the Blog section to the site navigation in `mkdocs.yml`. * Update CSS build process in deploy workflow Replaced the Python-based SCSS compilation with an npm-based process. This ensures compatibility with the updated build pipeline and leverages the existing npm tools for CSS processing. * Update deploy-live workflow with CSS build step Added a missing CSS build step in the deploy-live workflow to ensure the static site is built with the correct styles. This ensures consistency in the deployment process and addresses potential style-related issues. * Update deploy-live workflow with CSS build step Added a missing CSS build step in the deploy-live workflow to ensure the static site is built with the correct styles. This ensures consistency in the deployment process and addresses potential style-related issues. |
||
|
|
60ef48d988 |
Blog/2025 05 20 test blog post (#52)
* Remove unused font-face definitions from stylesheets The `fonts.scss` file defining `Assistant` font-face rules has been deleted as it was no longer in use. This cleanup reduces unnecessary assets and improves maintainability. * Fix npm script command in blog preview workflow Replaced `npm scss:build` with the correct `npm run scss:build` command in the GitHub Actions workflow. This ensures the SCSS build step executes properly during site generation. * Update blog preview workflow to use mkdocs gh-deploy Replaces the GitHub Pages action with `mkdocs gh-deploy` for deploying previews. Simplifies the workflow configuration and reduces dependencies. * Update `site_url` logic and fix URL format consistency Simplified the `site_url` handling in the workflow by removing branch-specific URL construction. Additionally, ensured the main URL in `mkdocs.yml` uses a consistent trailing slash. This enhances clarity and maintains uniformity in URL formatting. * Set `use_directory_urls` in mkdocs.yml directly. Removed redundant script lines for configuring `use_directory_urls` in the workflow file. This simplifies deployment logic by directly defining the configuration in the mkdocs.yml file. * Remove unnecessary CSS source map file Deleted `custom.css.map` as it is not required for production. Removing it helps reduce clutter and keeps the repository clean. * Add support for 'satware.ai' as a homepage path Updated body-classes.js to treat 'satware.ai' as a homepage path by adding the 'home' class to the body element. This ensures correct behavior for both empty paths and specific developer GitHub Pages. * Simplify FAQ and navigation structure. Renamed `faq.md` to `index.md` for consistency and updated navigation links in `mkdocs.yml` to use folder paths directly. Adjusted `main.html` to clean up formatting with additional line breaks. * Update footer links to use relative paths Replaced absolute paths with relative paths for internal footer links to ensure consistency and improve maintainability. External links remain unchanged. * Fix relative URL for Jane Alesi's team page in authors file Updated the URL path for Jane Alesi to ensure correct navigation to her team page. This fixes a broken link caused by an incorrect relative URL. * Update footer links and enhance blog post on website relaunch Updated footer links to utilize dynamic `config.site_url` for consistent URL routing. Enhanced the blog post for better readability, showcasing the MkDocs implementation, GitHub integration, and use of Mermaid diagrams. * Update footer link and simplify satWay documentation Replaced the "Blog" link in the footer with "satWay Prinzipien" and refined the satWay documentation by removing overly detailed content about Jane Alesi. Additionally, added the Blog section to the site navigation in `mkdocs.yml`. * Update CSS build process in deploy workflow Replaced the Python-based SCSS compilation with an npm-based process. This ensures compatibility with the updated build pipeline and leverages the existing npm tools for CSS processing. * Update deploy-live workflow with CSS build step Added a missing CSS build step in the deploy-live workflow to ensure the static site is built with the correct styles. This ensures consistency in the deployment process and addresses potential style-related issues. |
||
|
|
9fbea33697 |
Blog/2025 05 20 test blog post (#51)
* Remove unused font-face definitions from stylesheets The `fonts.scss` file defining `Assistant` font-face rules has been deleted as it was no longer in use. This cleanup reduces unnecessary assets and improves maintainability. * Fix npm script command in blog preview workflow Replaced `npm scss:build` with the correct `npm run scss:build` command in the GitHub Actions workflow. This ensures the SCSS build step executes properly during site generation. * Update blog preview workflow to use mkdocs gh-deploy Replaces the GitHub Pages action with `mkdocs gh-deploy` for deploying previews. Simplifies the workflow configuration and reduces dependencies. * Update `site_url` logic and fix URL format consistency Simplified the `site_url` handling in the workflow by removing branch-specific URL construction. Additionally, ensured the main URL in `mkdocs.yml` uses a consistent trailing slash. This enhances clarity and maintains uniformity in URL formatting. * Set `use_directory_urls` in mkdocs.yml directly. Removed redundant script lines for configuring `use_directory_urls` in the workflow file. This simplifies deployment logic by directly defining the configuration in the mkdocs.yml file. * Remove unnecessary CSS source map file Deleted `custom.css.map` as it is not required for production. Removing it helps reduce clutter and keeps the repository clean. * Add support for 'satware.ai' as a homepage path Updated body-classes.js to treat 'satware.ai' as a homepage path by adding the 'home' class to the body element. This ensures correct behavior for both empty paths and specific developer GitHub Pages. * Simplify FAQ and navigation structure. Renamed `faq.md` to `index.md` for consistency and updated navigation links in `mkdocs.yml` to use folder paths directly. Adjusted `main.html` to clean up formatting with additional line breaks. * Update footer links to use relative paths Replaced absolute paths with relative paths for internal footer links to ensure consistency and improve maintainability. External links remain unchanged. * Fix relative URL for Jane Alesi's team page in authors file Updated the URL path for Jane Alesi to ensure correct navigation to her team page. This fixes a broken link caused by an incorrect relative URL. * Update footer links and enhance blog post on website relaunch Updated footer links to utilize dynamic `config.site_url` for consistent URL routing. Enhanced the blog post for better readability, showcasing the MkDocs implementation, GitHub integration, and use of Mermaid diagrams. * Update footer link and simplify satWay documentation Replaced the "Blog" link in the footer with "satWay Prinzipien" and refined the satWay documentation by removing overly detailed content about Jane Alesi. Additionally, added the Blog section to the site navigation in `mkdocs.yml`. |
||
|
|
9ec744a042 |
Live (#50)
* Remove unused assets including logo and Lunr language files Deleted the site logo SVG and minimized Lunr language files for Arabic and Danish. These assets were no longer needed and were removed to reduce unused files in the project. * Add .repoinsight configuration for satware.ai project This commit introduces a profile.yml file to configure RepoInsight for analyzing the satware.ai project. It specifies scan directories, exclusion patterns, LLM parameters, and output options to generate concise project insights. The configuration is tailored for efficient processing and markdown output. * Add CNAME file for custom domain This adds a CNAME file specifying "test.satware.ai" as the custom domain. It ensures proper domain configuration for the project’s documentation. * Add Dockerfile for customized mkdocs-material setup This Dockerfile sets up mkdocs-material with additional plugins to enhance functionality, such as macros, glightbox, and RSS support. It streamlines the process of configuring a tailored mkdocs environment for documentation needs. * Refactor directory structure and update references Moved documentation and team files to new directories, updated paths for assets and links, and adjusted MkDocs configuration accordingly. Added GitHub Actions workflow for test environment deployment, and updated `.gitignore` with `.cache` directory. * Remove unused Font Awesome Pro stylesheet Deleted an unused CSS file referencing Font Awesome Pro 6.7.1. This reduces unnecessary assets and ensures compliance with licensing terms. * Fix typo in SCSS compilation script name in workflow Corrected the script name from 'compily_scss.py' to 'compile_scss.py' in the deployment workflow. This ensures the CSS build step runs successfully during the deployment process. * Add libsass installation step in deploy-test workflow The deploy-test workflow now includes libsass in the dependencies to ensure proper build and styling support. This update resolves potential issues related to missing CSS preprocessor functionality. * Add GitHub Actions workflow for live MkDocs deployment This workflow automates the deployment of MkDocs to the live environment upon a push to the `live` branch. It includes dependency installation, site building, and deployment to GitHub Pages with custom domain support. * Update deploy workflow to enhance build process Replaced mkdocs-material installation with the imaging option for improved functionality. Added a new step to compile SCSS before building the site, ensuring styles are properly processed. * Update deployment workflow and dependencies for GitHub Pages Switched deployment branch to "main" and updated GitHub Actions workflow to align with current standards, including caching dependencies and using updated action versions. Revised dependencies in `requirements.txt` and corrected CNAME for production domain. Adjusted footer links in HTML override for improved consistency. * Fix indentation in deploy-live workflow Corrected the indentation for the 'mkdocs build' step in the deploy-live workflow file. This ensures proper execution of the workflow during deployment. * Update deployment workflow to use 'live' branch Changed the deployment branch from 'main' to 'live' in the workflow configuration. This ensures that only changes pushed to the 'live' branch trigger deployments to production. * Update deploy step to use mkdocs gh-deploy Replaces the GitHub Pages action with the native mkdocs gh-deploy command. This simplifies the workflow and ensures consistent deployment behavior. The `--force` flag is added to override potential publishing conflicts. * Update team member links to use relative paths Replaced absolute paths with relative paths for team member profiles in the team index page. This ensures better portability and consistency across different environments. |