Skip to content

Conversation

@dmtrshat
Copy link
Member

@dmtrshat dmtrshat commented Sep 2, 2025

This pull request introduces several new content files and a comprehensive pre-publish script to automate documentation and asset generation for the project. The main focus is on improving documentation structure, automating the README build process, and providing up-to-date project information, badges, and release notes.

Documentation and Content Additions:

  • Added new markdown content files for badges, hero image, project slogan, desk (online playground), note (site recommendation), Arcane Circle (community), and release information, enriching the documentation and improving project presentation.

Automation and Build Improvements:

  • Introduced scripts/pre_publish.sh, a pre-publish helper script that:
    • Generates a sorted list of CSS animations from the codebase.
    • Updates the animations section in documentation.
    • Composes README.md from modular content blocks.
    • Optionally updates the table of contents using doctoc.

Copilot AI review requested due to automatic review settings September 2, 2025 00:27
@github-project-automation github-project-automation bot moved this to Backlog in Grimoire CSS Sep 2, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request implements a comprehensive documentation automation system and introduces several new content files to improve project presentation. The main focus is on automating the README.md build process from modular content blocks and generating up-to-date animation lists from the codebase.

Key changes include:

  • New pre-publish automation script that generates animations list and assembles README from content modules
  • Addition of modular content files (badges, hero image, project slogan, etc.) for flexible documentation composition
  • Complete README regeneration using the new modular system with embedded content blocks

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
scripts/pre_publish.sh Core automation script that generates animations list and composes README from content blocks
content/*.md Modular content files for badges, hero image, slogan, community info, and release notes
content/animations*.txt Generated animation lists from codebase CSS files
content/about.md Template file with content insertion markers for README generation
README.md Regenerated documentation file assembled from modular content blocks

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@dmtrshat dmtrshat merged commit c13dd8f into main Sep 2, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from Backlog to On RC in Grimoire CSS Sep 2, 2025
@dmtrshat dmtrshat deleted the chore/#96-update-docs-and-pre-publish-script branch September 2, 2025 00:41
@dmtrshat dmtrshat moved this from On RC to Done in Grimoire CSS Dec 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants