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

Split readme up into smaller files. #142

Open
RebeccaStevens opened this issue Jun 21, 2019 · 5 comments
Open

Split readme up into smaller files. #142

RebeccaStevens opened this issue Jun 21, 2019 · 5 comments
Assignees
Labels
fixed in eslint port This issue has been fixed in github.com/jonaskello/eslint-plugin-ts-immutable

Comments

@RebeccaStevens
Copy link
Collaborator

The readme has become huge and hard to manage; it needs to be broken up into multiple smaller files.

@jonaskello
Copy link
Owner

Yes, perhaps we could look into using a format that will work with a site generator like readthedocs or something similar and have that published to github pages. Should I look into this or have you already started work on it?

@RebeccaStevens
Copy link
Collaborator Author

Sounds like a nice way to do it. I haven't done anything with regards to this issue. If you'd like to take this on go ahead :)

@jonaskello jonaskello self-assigned this Jun 23, 2019
@jonaskello
Copy link
Owner

I investigated this and evalutated two options. One is to use jekyll, it is the most integrated way with github pages. However it involves ruby and I'm not using ruby for anything else so for that reason it was not a good option. I also found docusaurus which is based on nodejs and react and has github pages support. It seems like a good option.

However since we are now moving to eslint I'll focus my efforts there instead and at least initially try to follow how they do the docs over at typescript-eslint.

@RebeccaStevens
Copy link
Collaborator Author

I haven't had much of a look at docusaurus yet but on surface it looks quite good.

I think typescript-eslint's docs are done the same way as eslint so that sounds like a good way start :)

We probably can leave this repo as is.

@RebeccaStevens
Copy link
Collaborator Author

I just found docsify. Might also be worth looking into.

@RebeccaStevens RebeccaStevens added transferred to eslint port This issue has been transferred to github.com/jonaskello/eslint-plugin-ts-immutable fixed in eslint port This issue has been fixed in github.com/jonaskello/eslint-plugin-ts-immutable and removed transferred to eslint port This issue has been transferred to github.com/jonaskello/eslint-plugin-ts-immutable labels Jul 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fixed in eslint port This issue has been fixed in github.com/jonaskello/eslint-plugin-ts-immutable
Projects
None yet
Development

No branches or pull requests

2 participants