Lightning-AI / Lightning-AI/pytorch-lightning

Make it easy to contribute to the docs by carving out the docs

Open
#13,509 2 comments 0 reactions 1 assignee View on GitHub

@Borda is already working on this.

Since Jul 3, 2022.

docs
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

🚀 Feature

Separate docs repository that is easy and lightning fast to contribute to. 😄

Motivation

When something is hard only a small subset of people want to contribute. Contributing to the docs could be very easy and lightning fast. But its not, because the docs are part of a large repository with a very heavy installation and build process.

Context

I just want to contribute examples to the documentation about adding web ui to the Lightning Framework. I'm working on windows in a constrained enterprise environment. I cannot install make. I can install python packages via pip and conda. I can use docker.

cc @borda @rohitgr7

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.