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 instructions for building the documentation to the readme #3

Open
matthewp opened this issue Feb 13, 2017 · 3 comments
Open

Add instructions for building the documentation to the readme #3

matthewp opened this issue Feb 13, 2017 · 3 comments

Comments

@matthewp
Copy link
Contributor

matthewp commented Feb 13, 2017

@chasenlehara commented on Tue Aug 09 2016:

It’d be helpful to have instructions for building the docs in the generated readme.

I believe this is the file that needs to be modified: https://github.com/donejs/generator-donejs/blob/master/app/templates/readme.md

@leoj3n
Copy link

leoj3n commented Mar 6, 2017

@matthewp I don't understand why this issue was moved from donejs/generator-donejs to here.

When @chasenlehara says "instructions for building the docs", I assume he is talking about documentation for how to utilize the app/templates/documentjs.json in the generated app.

Are you saying you want donejs/donejs-documentjs to inject markdown into generator-donejs/blob/master/app/templates/readme.md, something like that? It seems like you would just add such doc building instructions to that readme markdown file by hand, hence this issue would make more sense back where it was?

/cc @chasenlehara

@matthewp
Copy link
Contributor Author

matthewp commented Mar 7, 2017

It doesn't make sense to have instructions on running documentation in the app generator, since you can't run documentation until you've installed documentjs. Maybe instead there is something like:

## Documentation

To run document first add documentjs: `donejs add documentjs`...

@chasenlehara
Copy link
Member

I think some things are being confused here.

I filed that issue when we were including DocumentJS. Now that it’s separated into this repo, I think we should (optionally?) add these instructions when donejs add documentjs is run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants