openlibhums / openlibhums/memory-alpha

Assess developer doc style with regard to general style guide

Open
#148 1 comment 0 reactions 1 assignee View on GitHub

@joemull is already working on this.

Since Mar 6, 2025.

documentation Priority high size M
Dominant language
Markdown
Stars
0
Forks
0
Avg merge
4d 14h
Merged PRs (30d)
2

Description

Content needed

We have drafted a style guide for use in Janeway end user documentation. It draws on the Google developer documentation style guide, and some of the recommendations in that guide are more about actual developer-facing documentation than end-user-facing docs.

So we need a developer to assess the parts of the Google guide that we want to adopt or adapt, and make updates to the Janeway style guide. This information should perhaps live not in memory-alpha but in the Janeway repository, given our choice to keep dev docs in openlibhums/janeway

We also need a developer to update the Contributing to Janeway documentation guide. Some of it can go away now that we have more comprehensive rules in the style guide, or be merged into the style guide. What's left will probably just be the nuts and bolts of using GH to write or edit docs, as well as pointers to the style guide. It should maybe be renamed Contributing to Janeway user documentation to make it clear it's about writing end-user docs and not developer docs.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.