DOCS: Create AboutCode doc system

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript, markdown
Domain
documentation

Research direction

Start by reviewing the existing documentation at aboutcode.readthedocs.io/ and the Diátaxis framework linked in the issue. Define the proposed structure and guidance for project documentation, README files, CONTRIBUTING files, and repository descriptions; done means the documentation system is published and explains how AboutCode projects should apply it.

Written by the indexing model from the issue text.

Description

documentation

To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.

Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.

Dominant language
JavaScript
Stars
9
Forks
18
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 aboutcode-org/www.aboutcode.org

All issues in aboutcode-org/www.aboutcode.org

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.