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

Hyde docs #209

Open
jaredly opened this Issue May 4, 2013 · 5 comments

Comments

Projects
None yet
5 participants
@jaredly

jaredly commented May 4, 2013

So...they're horrendous?
I really want to like hyde, but getting anything done requires spending >30 minutes digging through source code...

@navilan

This comment has been minimized.

Show comment
Hide comment
@navilan

navilan May 4, 2013

Member

So...they're horrendous?

he he - yeah - ATM, they are.

Will be working on them next week.

Member

navilan commented May 4, 2013

So...they're horrendous?

he he - yeah - ATM, they are.

Will be working on them next week.

@jaredly

This comment has been minimized.

Show comment
Hide comment
@jaredly

jaredly May 4, 2013

Awesome :) I'll be able to contribute a fair amount I expect, having dug
around so much the past few days.

On Sat, May 4, 2013 at 12:25 AM, Lakshmi Vyas notifications@github.comwrote:

So...they're horrendous?
he he - yeah - ATM, they are.

Will be working on them next week.


Reply to this email directly or view it on GitHubhttps://github.com//issues/209#issuecomment-17428649
.

jaredly commented May 4, 2013

Awesome :) I'll be able to contribute a fair amount I expect, having dug
around so much the past few days.

On Sat, May 4, 2013 at 12:25 AM, Lakshmi Vyas notifications@github.comwrote:

So...they're horrendous?
he he - yeah - ATM, they are.

Will be working on them next week.


Reply to this email directly or view it on GitHubhttps://github.com//issues/209#issuecomment-17428649
.

CharString referenced this issue in tasn/hyde Mar 5, 2014

Add plugin: HtmlMinPlugin for minifying HTML.
This plugin uses the htmlmin plugin to minify html.
It's very simple, but supports all of the htmlmin configurations.
@CharString

This comment has been minimized.

Show comment
Hide comment
@CharString

CharString Mar 5, 2014

To get and keep this going we need to document how to document.
Move the docs into this repo, so we can enforce a rule that new functionality only gets pulled when it is documented and tested properly.

If it isn't tested it's broken. If it isn't documented, it doesn't exist.

CharString commented Mar 5, 2014

To get and keep this going we need to document how to document.
Move the docs into this repo, so we can enforce a rule that new functionality only gets pulled when it is documented and tested properly.

If it isn't tested it's broken. If it isn't documented, it doesn't exist.

@llonchj llonchj added this to the Version 0.9.0 milestone May 25, 2015

@llonchj

This comment has been minimized.

Show comment
Hide comment
@llonchj

llonchj May 25, 2015

Contributor

+1 to move the docs into this repo

Contributor

llonchj commented May 25, 2015

+1 to move the docs into this repo

@jonafato

This comment has been minimized.

Show comment
Hide comment
@jonafato

jonafato Aug 24, 2015

Member

This seems to be a duplicate of #188.

Member

jonafato commented Aug 24, 2015

This seems to be a duplicate of #188.

jonafato added a commit that referenced this issue Feb 29, 2016

[WIP] Add Sphinx docs
This is the starting point of documenting Hyde using Sphinx. This
provides several benefits:

1. Code and documentation live together, so it's easier to track and
enforce that there exists documentation for new or changing code.

2. This lets us get Hyde on Read The Docs.

3. We can use things like `autoclass` where appropriate to pull
documentation directly from source code without reinventing the wheel.

I've tried to replicate what currently exists on hyde.github.io. The
first pass of this effort is concerned with parity, and we can continue
to improve from there on. Steps:

1. Convert all existing documentation on hyde.github.io to Sphinx. This
is covered by this commit and should be considered "in review".

2. Open issues for core parts of Hyde that are missing documentation.

3. Close these issues individually. This is a great opportunity for
community members wishing to get involved to contribute.

4. Require significant changes in code to be accompanied by updated /
new documentation the same way we would require tests.

While these steps are in progress, the following should also be done:

1. Deprecate the docs at hyde.github.io, linking users to Read The Docs.

2. Replace the content currently hosted at hyde.github.io with a new
brochure site showing off some of Hyde's uses and linking to other
interesting content (e.g. a list of themes, links to sites powered by
Hyde, etc.).

References #188, #209, and quite a few other issues.

@lakshmivyas, @llonchj: please review. This is a starting point for
Sphinx docs, and the PR is labelled as a work in progress, but I have no
specific threshold for it being "done". Once we're all satisfied with
the first pass, I'll set up RTD, and we can start filing issues for
specific areas lacking docs.

jonafato added a commit that referenced this issue Feb 29, 2016

[WIP] Add Sphinx docs
This is the starting point of documenting Hyde using Sphinx. This
provides several benefits:

1. Code and documentation live together, so it's easier to track and
enforce that there exists documentation for new or changing code.

2. This lets us get Hyde on Read The Docs.

3. We can use things like `autoclass` where appropriate to pull
documentation directly from source code without reinventing the wheel.

I've tried to replicate what currently exists on hyde.github.io. The
first pass of this effort is concerned with parity, and we can continue
to improve from there on. Steps:

1. Convert all existing documentation on hyde.github.io to Sphinx. This
is covered by this commit and should be considered "in review".

2. Open issues for core parts of Hyde that are missing documentation.

3. Close these issues individually. This is a great opportunity for
community members wishing to get involved to contribute.

4. Require significant changes in code to be accompanied by updated /
new documentation the same way we would require tests.

While these steps are in progress, the following should also be done:

1. Deprecate the docs at hyde.github.io, linking users to Read The Docs.

2. Replace the content currently hosted at hyde.github.io with a new
brochure site showing off some of Hyde's uses and linking to other
interesting content (e.g. a list of themes, links to sites powered by
Hyde, etc.).

References #188, #209, and quite a few other issues.

@lakshmivyas, @llonchj: please review. This is a starting point for
Sphinx docs, and the PR is labelled as a work in progress, but I have no
specific threshold for it being "done". Once we're all satisfied with
the first pass, I'll set up RTD, and we can start filing issues for
specific areas lacking docs.

jonafato added a commit that referenced this issue Feb 29, 2016

[WIP] Add Sphinx docs
This is the starting point of documenting Hyde using Sphinx. This
provides several benefits:

1. Code and documentation live together, so it's easier to track and
enforce that there exists documentation for new or changing code.

2. This lets us get Hyde on Read The Docs.

3. We can use things like `autoclass` where appropriate to pull
documentation directly from source code without reinventing the wheel.

I've tried to replicate what currently exists on hyde.github.io. The
first pass of this effort is concerned with parity, and we can continue
to improve from there on. Steps:

1. Convert all existing documentation on hyde.github.io to Sphinx. This
is covered by this commit and should be considered "in review".

2. Open issues for core parts of Hyde that are missing documentation.

3. Close these issues individually. This is a great opportunity for
community members wishing to get involved to contribute.

4. Require significant changes in code to be accompanied by updated /
new documentation the same way we would require tests.

While these steps are in progress, the following should also be done:

1. Deprecate the docs at hyde.github.io, linking users to Read The Docs.

2. Replace the content currently hosted at hyde.github.io with a new
brochure site showing off some of Hyde's uses and linking to other
interesting content (e.g. a list of themes, links to sites powered by
Hyde, etc.).

References #188, #209, and quite a few other issues.

@lakshmivyas, @llonchj: please review. This is a starting point for
Sphinx docs, and the PR is labelled as a work in progress, but I have no
specific threshold for it being "done". Once we're all satisfied with
the first pass, I'll set up RTD, and we can start filing issues for
specific areas lacking docs.

jonafato added a commit that referenced this issue Feb 29, 2016

[WIP] Add Sphinx docs
This is the starting point of documenting Hyde using Sphinx. This
provides several benefits:

1. Code and documentation live together, so it's easier to track and
enforce that there exists documentation for new or changing code.

2. This lets us get Hyde on Read The Docs.

3. We can use things like `autoclass` where appropriate to pull
documentation directly from source code without reinventing the wheel.

I've tried to replicate what currently exists on hyde.github.io. The
first pass of this effort is concerned with parity, and we can continue
to improve from there on. Steps:

1. Convert all existing documentation on hyde.github.io to Sphinx. This
is covered by this commit and should be considered "in review".

2. Open issues for core parts of Hyde that are missing documentation.

3. Close these issues individually. This is a great opportunity for
community members wishing to get involved to contribute.

4. Require significant changes in code to be accompanied by updated /
new documentation the same way we would require tests.

While these steps are in progress, the following should also be done:

1. Deprecate the docs at hyde.github.io, linking users to Read The Docs.

2. Replace the content currently hosted at hyde.github.io with a new
brochure site showing off some of Hyde's uses and linking to other
interesting content (e.g. a list of themes, links to sites powered by
Hyde, etc.).

References #188, #209, and quite a few other issues.

@lakshmivyas, @llonchj: please review. This is a starting point for
Sphinx docs, and the PR is labelled as a work in progress, but I have no
specific threshold for it being "done". Once we're all satisfied with
the first pass, I'll set up RTD, and we can start filing issues for
specific areas lacking docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment