axone-protocol / docs

📜 Axone documentation portal (built with Docusaurus).
https://docs.axone.xyz/
BSD 3-Clause "New" or "Revised" License
40 stars 22 forks source link

ci(workflow): add generate-doc-bundles workflow #355

Closed ccamel closed 10 months ago

ccamel commented 10 months ago

Context

As part of the training process for OKP4 GPT, there is a requirement to assemble comprehensive markdown files that consolidate various segments of our documentation. These segments include:

  1. A bundle comprising:

    • The Whitepaper
    • Technical Documentation
    • FAQs
  2. Another bundle containing:

    • Tutorials
    • Validators Documentation

PR scope

This PR introduces a new github workflow, manually triggerable, which aims to generate these specified bundles, making them available as downloadable artifacts. These artifacts will serve as primary (and canonical) inputs for the training phase of OKP4 GPT.

Usage

The workflow is manualy triggerable:

image

Once run, it will produce 2 downloadable artefacts:

image

Summary by CodeRabbit

coderabbitai[bot] commented 10 months ago

[!NOTE]

Reviews Paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The change involves the introduction of a GitHub Actions workflow designed to automate the generation of documentation bundles. Triggered by workflow calls, it employs a matrix strategy to handle multiple documentation sets, sets up Python, installs dependencies, merges Markdown files into bundles, and uploads these as artifacts, all while managing concurrency to ensure smooth operation across multiple runs.

Changes

File Path Change Summary
.github/workflows/generate-doc-bundles.yml Introduced a GitHub Actions workflow for generating documentation bundles with a matrix strategy, Python setup, dependencies installation, Markdown merging, and artifact uploading.

🐇✨ In the realm of code, where actions flow, A rabbit crafted docs, with a seamless glow. Bundles of knowledge, now swiftly compile, In GitHub's embrace, they rest for a while. 📚💫


Tips ### Chat with CodeRabbit Bot (`@coderabbitai`) - If you reply to a *review comment* from CodeRabbit, the bot will automatically respond. - To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment - Note: Review comments are made on code diffs or files, not on the PR overview. - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Note: For conversation with the bot, please use the review comments on code diffs or files. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json`
ccamel commented 10 months ago

@coderabbitai pause