serde-rs / serde-rs/serde-rs.github.io

Set up GitHub Actions to automatically build gitbook

Open
#7 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

process
Dominant language
HTML
Stars
23
Forks
109
PR merge metrics
No merged PRs in 30d

Description

Currently I need to update both the markdown source and the generated html. I should be able to push changes to markdown and have GitHub Actions push a commit containing built html.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the repository's Markdown source and generated HTML, then inspect how GitBook is currently built and published. Configure GitHub Actions so a Markdown change triggers the build and commits the resulting HTML; verify this with a workflow run and confirm that generated output is updated automatically.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, markdown
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.