Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add grammar documentation template #645

Conversation

kendonB
Copy link
Collaborator

@kendonB kendonB commented Jul 13, 2019

Add Grammar Documentation Template

Description

This pull request adds a template for grammar documentation (e.g. Mouse.md, Text_Manipulation.md, and Bringme.md).

Related Issue

None.

Motivation and Context

There was a lot of style inconsistency in the documentation and this pull request aims to prevent that. It provides a template for adding new documentation, as well as defining some style conventions (subject to change upon discussion). In particular, it asks that can phrases be referred to using italics and variables in the command phrase spec be referred to using backticks.

How Has This Been Tested

No testing yet.

Types of changes

  • Docs change / refactoring / dependency upgrade
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • I have checked that my code does not duplicate functionality elsewhere in Caster.
  • My code implements all the features I wish to merge in this pull request.

Maintainer/Reviewer Checklist

  • Basic functionality has been tested and works as claimed.
  • New documentation is clear and complete.
  • Code is clear and readable.

@LexiconCode LexiconCode added Meta Everything that is not directly related Code or Documentation, e.g. GitHub, Wiki, Website, Community Caster Issues pertaining to primarily the Caster project. New Feature A new feature that is not currently implemented. labels Jul 13, 2019
@LexiconCode

This comment has been minimized.

@kendonB
Copy link
Collaborator Author

kendonB commented Jul 13, 2019

I'll also make changes to CONTRIBUTING.md once we have settled on this style as the way to go and this has been merged.

@LexiconCode LexiconCode merged commit 595bc58 into dictation-toolbox:master Jul 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Caster Issues pertaining to primarily the Caster project. Meta Everything that is not directly related Code or Documentation, e.g. GitHub, Wiki, Website, Community New Feature A new feature that is not currently implemented.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants