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

Update Documentation and Purge Extras #44

Merged
merged 1 commit into from Feb 14, 2013
Merged

Conversation

ryanycoleman
Copy link

@laurenrother this replaces your #41 pull request. Does it meet your goals?


Commit message from laurenrother
Before alterations, this content was the module author-determined
description of and instructions for use of the module.

As part of a joint Forge/Docs team effort to standardize formatting and
encourage quality module documentation, a best practices README
template was created via internal and external user testing. That
template was then applied to this module.

I pulled in content from the original README on GitHub as well as the
Forge Module Description. Standard headings were added (Overview,
Module Description, Setup, Usage,
Implementation, etc.) to organize content, existent content was moved
under its appropriate heading and edited for tone/flow/clarity, and
basic formatting was done to
adhere to template standards.

Extraneous, empty READMEs were deleted.

Commit message from laurenrother
Before alterations, this content was the module author-determined
description of and instructions for use of the module.

As part of a joint Forge/Docs team effort to standardize formatting and
encourage quality module documentation, a best practices README
template was created via internal and external user testing. That
template was then applied to this module.

I pulled in content from the original README on GitHub as well as the
Forge Module Description. Standard headings were added (Overview,
Module Description, Setup, Usage,
Implementation, etc.) to organize content, existent content was moved
under its appropriate heading and edited for tone/flow/clarity, and
basic formatting was done to
adhere to template standards.

Extraneous, empty READMEs were deleted.
@lrnrthr
Copy link

lrnrthr commented Feb 13, 2013

@RColeman , that covers all of it. Thanks!

ryanycoleman pushed a commit that referenced this pull request Feb 14, 2013
Update Documentation and Purge Extras
@ryanycoleman ryanycoleman merged commit e1c8433 into master Feb 14, 2013
@DavidS DavidS deleted the readme_update branch July 19, 2016 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants