Viewing rendered docs from a PR to check

Open
#363 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
32/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
github-actions
Domain
ci-cd, documentation

Research direction

Review the referenced .github/workflows/docs.yml in the Excalibur repository to understand the proposed rendered-docs workflow, then inspect this repository’s documentation and CI configuration. Done means a pull request can render the documentation for checking before merge.

Written by the indexing model from the issue text.

Description

enhancement

We don't have any way of viewing rendered docs from a PR to check them before merging do we?

For what is worth, we do that in the excalibur benchmarking repository: https://github.com/ukri-excalibur/excalibur-tests/blob/ede38fa104eed72557233cbfc76b230727973791/.github/workflows/docs.yml (this is using mkdocs rather than jekyll, but to give an idea of what one can do to accomplish that).

Originally posted by @giordano in https://github.com/UCL-ARC/python-tooling/issues/358#issuecomment-2077433013

Dominant language
Python
Stars
62
Forks
10
Avg merge
7d 6h
Merged PRs (30d)
6

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.

More from UCL-ARC/python-tooling

All issues in UCL-ARC/python-tooling

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.