uber / uber/h3

Reorganize Overview/Core Library sections of the docs

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

@nrabinowitz is already working on this.

Since Aug 8, 2019.

documentation
Dominant language
C
Stars
6.5k
Forks
627
Avg merge
3d 21h
Merged PRs (30d)
6

Description

  • Rename Core Library to Library Internals
  • Move general-audience sections (overview, res table) to Overview
  • Add page for gotchas (maybe Caveats or Special Considerations)
  • Add FAQ page (gotchas, distortion/edge length, reference geoid, etc)

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.