uabrc / uabrc/uabrc.github.io

Article describing how to (re)build our documentation from the ground up.

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

Nobody has claimed this yet.

style: article/section 📝
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

What would you like to see added?

CryoEM folks are interested in building documentation like ours for the purposes of initiating, supporting and training researchers in CryoEM and subsequent analysis pipelines. We don't support documenting research software, procedures and instrumentation as it's outside our scope. I foresee this becoming a more common use case across campus as well. I see an opportunity for us to put more power into the hands of researchers by showing how they can build and maintain documentation, like ours, for themselves.

So, let's build documentation on building documentation!

It's not clear that it should go into this repository, or into its own separate repository. My first assumption is that we should build a separate "template" repository with the minimum necessary parts. Then we can document the process, what we've learned, etc., in a clean space without documentation.

Contributor guide

No contributing guide indexed for this repository

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

The issue names no files, tests, or entry points. Begin by reviewing the existing documentation repository and the proposal for a separate template repository; done would mean a decided home for the material and documented guidance for building and maintaining similar research documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.