Skip to content
This repository has been archived by the owner on Jan 24, 2024. It is now read-only.

Writers' guide to stumptown #2319

Closed
wbamberg opened this issue Oct 23, 2019 · 2 comments
Closed

Writers' guide to stumptown #2319

wbamberg opened this issue Oct 23, 2019 · 2 comments
Assignees
Labels
Parked This issue was in a milestone, was not completed, and was not added to another milestone

Comments

@wbamberg
Copy link

We should have a document describing what stumptown-content looks like from the point of view of a technical writer. This should explain:

  • at a high level, what stumptown-content and stumptown-renderer are, and how they relate
  • at a high level, which bits of the stumptown-content repo are of interest to writers
  • what kind of files these bits contain
  • what recipes are for
  • how reference pages are written
  • how guide pages are written
  • how landing pages are written
  • how sidebars are specified
  • what all the currently designed ingredients are, and how they are to be written (e.g. browser_compatibility, examples, etc etc)
  • how to run stumptown-renderer to see the rendered version of the documentation pages

It does not need to go into the details of build-json or what the JSON interface looks like.


Acceptance criteria:

  • doc is written and reviewed by stumptown-content team
@wbamberg wbamberg added this to the Rissi Palmer (Q4 Sprint 2) milestone Oct 23, 2019
@wbamberg wbamberg self-assigned this Oct 23, 2019
@jmswisher jmswisher added the Parked This issue was in a milestone, was not completed, and was not added to another milestone label Nov 13, 2019
@jmswisher jmswisher removed this from the Rissi Palmer (Q4 Sprint 2) milestone Nov 13, 2019
@jmswisher
Copy link
Contributor

Parking until strategy is clearer.

@wbamberg
Copy link
Author

FWIW this is done: mdn/stumptown-content#197.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Parked This issue was in a milestone, was not completed, and was not added to another milestone
Projects
None yet
Development

No branches or pull requests

2 participants