question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Feedback on new documentation hosted on Github Pages

See original GitHub issue

As Simple Transformers grows, the single page README documentation has gotten quite bloated and difficult to use. Because of this, I’ve decided that it’s time (if not a little late already) to move the documentation to a more user-friendly Github Pages hosted website at the link below.

https://thilinarajapakse.github.io/simpletransformers/

As of now, only the text classification section is live but it should be enough to get an idea of how the final documentation will look like. If you guys have any feedback, ideas, concerns, or mistakes/typos to report, I’d love to hear from you. Since it is still being written, incorporating feedback and fixing issues will be much easier at this stage!

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:28 (19 by maintainers)

github_iconTop GitHub Comments

2reactions
kinoutecommented, May 3, 2020

I think this is great and it was the best thing to do. Now I would redo the README file to get rid of most of the things and do a clean file that links to some documentation chapters for people who want advanced explanations on some topics.

1reaction
ThilinaRajapaksecommented, Aug 10, 2020

Sounds good, thanks. Just a heads up, but I might make my own changes to any submitted docs.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Publish Your Project Documentation with GitHub Pages
Hosting your documentation on the web can present time-consuming challenges that make publishing and maintaining it an unrewarding experience — ...
Read more >
About GitHub Pages
GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs...
Read more >
Create compelling Documentation with Github Pages - ITNEXT
End-2-end One-Stop-Shop for all our Documentation; Easy creation of new pages and content structure; Govern and control look & feel centrally; Live Search ......
Read more >
How To Simplify the Dreaded Task of Documentation ...
Here's the trick: If you're using GitHub as your source code repository, you can take advantage of the service's built-in GitHub Pages feature ......
Read more >
How to create a documentation site with Docsify and GitHub ...
By default, GitHub Pages prompts users to use Jekyll, a static site generator that supports HTML, CSS, and other web technologies ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found