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

Update existing documentation #163

Open
aqrln opened this issue May 12, 2017 · 0 comments
Open

Update existing documentation #163

aqrln opened this issue May 12, 2017 · 0 comments
Labels
doc triage-normal

Comments

@aqrln
Copy link
Member

aqrln commented May 12, 2017 •
edited
Loading

Besides the lack of decent documentation, we also have another major doc-related issue: some of the docs and examples that we do have are vastly outdated and misleading. These must be fixed to reflect the current state of the project.

Ref: #151
@aqrln aqrln added the doc label May 12, 2017
@aqrln aqrln added this to the 1.0.0 milestone May 12, 2017
aqrln added a commit that referenced this issue May 12, 2017
@aqrln
doc: modernize README.md and add CoC
06a066c 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

Refs: #131
Refs: #163
aqrln added a commit that referenced this issue May 13, 2017
@aqrln
doc: modernize README.md and add CoC
f6a3e92 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
nechaido pushed a commit that referenced this issue May 18, 2017
@aqrln @nechaido
doc: modernize README.md and add CoC
1f5275e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@aqrln aqrln mentioned this issue Jun 26, 2017
Closed
aqrln added a commit that referenced this issue Jun 26, 2017
@aqrln
doc: remove examples/data-formats
3552f86 
Refs: #163
aqrln added a commit that referenced this issue Jul 1, 2017
@aqrln
doc: remove examples/data-formats
de7e1f8 
Refs: #163
PR-URL: #238
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@nechaido nechaido removed this from the 1.0.0 milestone Jul 31, 2017
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
68c1b22 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: remove examples/data-formats
a8bc31c 
Refs: #163
PR-URL: #238
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
b90041e 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: #166
Refs: #131
Refs: #163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit that referenced this issue Jan 22, 2018
@aqrln @belochub
doc: remove examples/data-formats
ad9a854 
Refs: #163
PR-URL: #238
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
1cc80c7 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 19, 2018
@aqrln
doc: modernize README.md and add CoC
3da9f2a 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub pushed a commit to metarhia/mdsf that referenced this issue Jul 21, 2018
@aqrln @belochub
doc: modernize README.md and add CoC
d4f85db 
* Remove obsolete and misleading information from `README.md`.
* Make `README.md` look cleaner.
* Add a Code of Conduct.
* Add a simple introductory example to the front page and duplicate it
  in `examples/readme-example`.
* Add the list of maintainers.

PR-URL: metarhia/jstp#166
Refs: metarhia/jstp#131
Refs: metarhia/jstp#163
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Mykola Bilochub <nbelochub@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
belochub added a commit that referenced this issue Feb 5, 2019
@belochub @nechaido
docs: use mkdocs for documentation
8279da0 
Refs: #163

Co-authored-by: Dmytro Nechai <nechaido@gmail.com>
@belochub belochub mentioned this issue Feb 5, 2019
Closed
mille-nium pushed a commit that referenced this issue Feb 15, 2019
@belochub @nechaido @mille-nium
docs: use mkdocs for documentation
4ef606f 
Refs: #163

Co-authored-by: Dmytro Nechai <nechaido@gmail.com>
belochub added a commit that referenced this issue Mar 29, 2019
@belochub @nechaido
docs: use mkdocs for documentation
707dcca 
Refs: #163

Co-authored-by: Dmytro Nechai <nechaido@gmail.com>
belochub added a commit that referenced this issue Mar 29, 2019
@belochub @nechaido
docs: use mkdocs for documentation
862a246 
Refs: #163
PR-URL: #410
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>

Co-authored-by: Dmytro Nechai <nechaido@gmail.com>
@belochub belochub mentioned this issue Apr 1, 2019
Open
belochub added a commit that referenced this issue Apr 12, 2019
@belochub @nechaido
docs: use mkdocs for documentation
db09d6a 
Refs: #163
PR-URL: #410
Reviewed-By: Timur Shemsedinov <timur.shemsedinov@gmail.com>
Reviewed-By: Dmytro Nechai <nechaido@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>

Co-authored-by: Dmytro Nechai <nechaido@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc triage-normal
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tshemsedinov @aqrln @nechaido