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

Move Documentation to Codebase #125

Closed
ebollens opened this issue Oct 16, 2012 · 3 comments
Closed

Move Documentation to Codebase #125

ebollens opened this issue Oct 16, 2012 · 3 comments
Assignees
@ebollens
Labels
Documentation: Content
Milestone
0.1.02

Comments

@ebollens
Copy link
Contributor

We've accrued a good amount documentation in the wiki, a lot of prototyping, some discussion and then also some actual definitions. However, the reality of the matter is that we also need user-friendly documentation that rides along with the code base itself. Might be able to draw this out of the prototypes folder in some cases, but going to try to cannonize it in the /docs folder in a user-friendly way.
@ghost ghost assigned ebollens Oct 16, 2012
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Add a Module.md description for coming documentation on modules [#125]
9ec5be6
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Move block readme to doc folder and sym link for template README.md [#…
2c4380a 
…125]
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Move image replacement readme to doc folder and sym link for template…
cb739a5 
… README.md [#125]
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Move structure readme to doc folder and sym link for template README.…
6c9f59f 
…md [#125]
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Move type readme to doc folder and sym link for template README.md [#125
e3533ca 
]
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Move visibility readme to doc folder and sym link for template README…
143cedb 
….md [#125]
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Add more details to Modules.md documentation [#125]
12c3704
@ebollens
Copy link
Contributor Author

As with 12c3704, currently working on doing some revisions to the base docs now that I've moved them over. I symlined the README.md files to their new location in the /doc folder.

ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Update Base/Block documentation [#125]
8928583
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Add mention to extends functionality in Base/Image-Replacement [#125]
ef3f624
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Rewrite Base/Structure documentation based on #113 features [#125]
b4b5b72
ebollens added a commit that referenced this issue Oct 16, 2012
@ebollens
Remove pluralisms in name scheme for documentation directories/files [#…
d60547b 
…125]
@ebollens
Copy link
Contributor Author

sigh doc writing is tedious.

ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Update Base/Visibility doc for changes to variable names [#125]
c87f0ee
ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Move table readme to doc folder and sym link for template README.md [#…
1bfda05 
…125]
ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Move blockquote readme to doc folder and sym link for template README…
6c0a1b1 
….md [#125]
ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Move button readme to doc folder and sym link for template README.md [#…
32b103d 
…125]
ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Move masthead readme to doc folder and sym link for template README.md [
5039166 
#125]
ebollens added a commit that referenced this issue Oct 17, 2012
@ebollens
Move nav readmes to doc folder and sym link for template README.md [#125
215a950 
]
@ebollens
Copy link
Contributor Author

The move is complete, although there are revisions to do still. Closing this.

ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Add a Module.md description for coming documentation on modules [#125]
813ecaf
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move block readme to doc folder and sym link for template README.md [#…
dbd78ab 
…125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move image replacement readme to doc folder and sym link for template…
e35d33e 
… README.md [#125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move structure readme to doc folder and sym link for template README.…
7c96826 
…md [#125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move type readme to doc folder and sym link for template README.md [#125
9acb74f 
]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move visibility readme to doc folder and sym link for template README…
b49f234 
….md [#125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Add more details to Modules.md documentation [#125]
77af251
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Update Base/Block documentation [#125]
825864b
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Add mention to extends functionality in Base/Image-Replacement [#125]
92c861c
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Rewrite Base/Structure documentation based on #113 features [#125]
7b7c33f
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Remove pluralisms in name scheme for documentation directories/files [#…
7b0cf5e 
…125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Update Base/Visibility doc for changes to variable names [#125]
d2ac22d
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move table readme to doc folder and sym link for template README.md [#…
3964087 
…125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move blockquote readme to doc folder and sym link for template README…
f5da5a0 
….md [#125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move button readme to doc folder and sym link for template README.md [#…
420b35a 
…125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move masthead readme to doc folder and sym link for template README.md [
4189bf4 
#125]
ebollens added a commit that referenced this issue Feb 22, 2013
@ebollens
Move nav readmes to doc folder and sym link for template README.md [#125
7c71b37 
]
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ebollens ebollens

Labels
Documentation: Content
Projects
None yet
Milestone
0.1.02
Development

No branches or pull requests
1 participant
@ebollens