aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

[Docs] Conduct doc comparison and workshops to fill knowledge gaps

Open clay-aptos opened this issue 2 years ago • 0 comments

Aptos Documentation Issue

Location

What are the existing URLs containing the issue, if any?

Initially internal, yet we should seek to take the publishing instructions public once tested.

Where should this information land if new? (Start Aptos, Build Apps, Run Nodes, Reference, etc.?

On a Help pager under a new Contribute section.

Description

How would you describe the issue?

We could benefit from evaluating competitor docs for gaps.

We could also better scale contributions internally and externally through better instructions, best practices, and live workshops explaining how to follow those materials and processes.

What needs changing?

We need to explain how the few of us contributing now work, covering:

  • Editing (in browser or CLI)
  • Linking (ex. work both in GitHub and in Aptos.dev)
  • Styling (ex. sentence case for sub-heads)
  • Staging (where to see previews)
  • Reviewing (whom should confirm what)

What changes are needed to support this new feature or product? (A simple overview, detailed procedures?

We (OK, I) need to compile the docs and teach them.

Audience

Who is the audience for that information? (App developers, investors, creators, validators, someone else?

Aptos Labs to begin with and then the world!

What precisely must they do with it? (Configure a new service? Process some output?

Make direct edits for the benefit of mankind!

clay-aptos avatar Jan 24 '23 22:01 clay-aptos