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

Added README to base-template and tweaked chunked list advice #22

Merged
merged 4 commits into from
Feb 15, 2021
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add README to base-template/
  • Loading branch information
Cameron Shorter committed Feb 14, 2021
commit 482b6089b51708e12a8a42ce2b77183a44255040
28 changes: 28 additions & 0 deletions base-template/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# What's in the base-template directory

This base-template directory contains templates and guides to be followed by a `doctype` template author. They can also be used by a project's docset owner select and customize the project's templates.
camerons marked this conversation as resolved.
Show resolved Hide resolved

**Version:** 0.1

**Last updated:** February, 2021

## How to use the base-template files
As a doctype author, you will be responsible for creating three documents:

**xxx-template:**
* Based on the _base-doctype-template_.
* The doctype's headings, standard text, and specific instructions for each section.

**xxx-guide-template:**
* Based on the _base-doctype-guide-template_.
* General guidance and background theory related to the _doctype_.

**xxx-example:**
* Based on the _doctype-example-guide_.
* An example implementation of the doctype, which explains our fake chronologue project.

Guidance for filling out these documents are provided as _template author tips_ within the above documents, as well as in the holistic _main-doctype-author-guide_.

## Contributing new templates

We welcome contributions to The Good Docs Project. Refer to our [contribution page](https://thegooddocsproject.dev/contribute.html) for details.