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.

Sign up for GitHub

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

Jump to bottom

Extract examples from comment documentation into separate files #607

Closed
jedeen opened this issue Jun 26, 2016 · 2 comments
Closed

Extract examples from comment documentation into separate files #607

jedeen opened this issue Jun 26, 2016 · 2 comments
Assignees
@kamranayub
Labels
organization Applied to any issue/pr around file or project organization
Milestone
0.8.0 Release

Comments

@jedeen
Copy link
Member

jedeen commented Jun 26, 2016

Context

Due to changes in TypeDoc, code examples can now be stored in separate files and pulled in as needed. This will make samples more manageable and let us track changes to them more easily.

Proposal

We should pull all of our documentation code examples out into separate files as per the new TypeDoc guidelines.
@jedeen jedeen added the organization Applied to any issue/pr around file or project organization label Jun 26, 2016
@jedeen jedeen added this to the 0.8.0 Release milestone Jun 26, 2016
@kamranayub
Copy link
Member

This should not be done until #606 is done, otherwise it'll be merge conflict city

@kamranayub kamranayub self-assigned this Nov 25, 2016
@kamranayub
Copy link
Member

Works.

image

image

You can also link to images via "media://" links and media folder but I think when we migrate to RTD it'll be better anyway.

@kamranayub kamranayub mentioned this issue Nov 25, 2016
Merged
1 task
kamranayub added a commit that referenced this issue Nov 30, 2016
@kamranayub
[#607] Extract major docs from code files to separate Markdown files (#…
b27a289 
…695)

Closes #607

## Changes:

- Extract major docs into separate folder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kamranayub kamranayub

Labels
organization Applied to any issue/pr around file or project organization
Projects
None yet
Milestone
0.8.0 Release
Development

No branches or pull requests
2 participants
@kamranayub @jedeen