a7f265a36f2ee810b384d6f8430f8a5a94e8bbc6
12
Commits
| Author | SHA1 | Message | Date | |
|---|---|---|---|---|
|
|
faf199aca7 |
feat: Improve documentation and add project files (#1) (#104)
* feat: Add CONTRIBUTING.md * feat: Add CODE_OF_CONDUCT.md * feat: Add SECURITY.md * feat: Add LICENSE file * feat: Update README.md with improved documentation and project details * fix: Generalize README.md for forking workflow * fix: Correct Project Structure in README.md * fix: Correct Build Status badge URL in README.md * fix: Correct Build Status badge URL to point to original repository's live workflow * fix: Correct License badge URL to point to original repository Co-authored-by: Jane Alesi <ja@satware.ai> |
||
|
|
ee8eba8549 |
Refactor MkDocs blog structure, enhance SCSS watcher, and improve plugin configuration (#103)
- Adjusted `mkdocs.sh` to expand SCSS watcher to include `docs` and `mkdocs.yml`. - Simplified blog template by extracting post logic to `partials/post.html`. - Updated `mkdocs.yml` with refined plugins including RSS, meta, and enhanced blog options. - Improved blog Markdown files with structural changes and better TOC handling. - Removed unused styles and deprecated logic in blog posts for cleaner maintenance. |
||
|
|
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. |
||
|
|
45a8890b9e |
Update mkdocs.yml (#90)
Signed-off-by: Michael Wegener <mw@satware.com> |
||
|
|
479b6f54e2 |
Feature/sequential thinking blog post (#76)
* feat: Add Sequential Thinking Blog Post with legal compliance - Add comprehensive blog post about Sequential Thinking Plugin launch - Include multi-agent collaboration from Jane, Theo, and Justus Alesi - Feature legal compliance review and financial disclaimers - Integrate technical specifications and practical examples - Add verified sources and evidence quality framework - Include Mermaid diagrams for visual explanation - Implement proper German localization with DACH market focus * feat: Update Sequential Thinking blog post with comprehensive content, legal compliance and verified sources - Added comprehensive Theo Alesi financial analysis section with Sequence-of-Returns Risk - Integrated Justus Alesi legal compliance review with UWG compliance - Included verified sources with tier classification system - Added proper disclaimers for financial content - Enhanced technical specifications and implementation details - Added visual diagrams via Mermaid for better understanding - Comprehensive quality assurance with all regulatory requirements * feat: Add Theo Alesi and Justus Alesi to blog authors - Added theo-alesi: Financial & Investment Intelligence Specialist - Added justus-alesi: Legal Expert for Swiss, German and EU Law - Required for Sequential Thinking blog post build to succeed * feat: Restructure blog post with finance usecase and moved disclaimer - Moved financial disclaimer to Theo Alesi section - Transformed Theo's section into comprehensive usecase with real scenario - Added detailed Sequential Thinking workflow for portfolio planning - Enhanced readability with step-by-step financial analysis example - Improved visual flow with Mermaid diagram for risk illustration - Maintained legal compliance while showcasing practical application --------- Co-authored-by: Jane Alesi <ja@satware.ai> |
||
|
|
84e9f0ce9c |
Blog/sequential thinking revolution (#75)
* Add Sequential Thinking blog post - rechtlich geprüft und quellenverifiziert * Add comprehensive documentation for Sequential Thinking blog branch --------- Co-authored-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. |