UCL-ARC / UCL-ARC/python-tooling

Switch from MkDocs to Zensical

Open
#619 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

What needs to be done?

Following #618

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

Start by reading issue #618, which this issue identifies as the context for the work. No files, tests, or entry points are named, so determine where MkDocs is configured before assessing the migration to Zensical; done means the documentation setup has been switched successfully.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.