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

Create separate pages for all the docs and info #317

Open
1 of 2 tasks
vbuberen opened this issue Apr 6, 2020 · 1 comment
Open
1 of 2 tasks

Create separate pages for all the docs and info #317

vbuberen opened this issue Apr 6, 2020 · 1 comment
Assignees
Labels
documentation enhancement New feature or improvement to the library feature request Request a new feature to be developed

Comments

@vbuberen
Copy link
Collaborator

vbuberen commented Apr 6, 2020

⚠️ Is your feature request related to a problem? Please describe

Currently there is some inconsistency in having README in develop branch.
In case of adding some feature and its description into develop users see this description and think that this feature is available in the latest stable release, while it might be not released yet. Such situation happened recently.
Also, Chucker already has quite an extensive amount of info which should be hosted somewhere.

💡 Describe the solution you'd like

Have some separate pages like Github pages or something like https://squidfunk.github.io/mkdocs-material/ (much better solution) and have all the info, docs (including KDocs), recipes and whatever might be useful for library users updated separately to not be influenced by updates in develop branch, so the info is always correct for the latest stable version.

🙋 Do you want to develop this feature yourself?

It is more yes than no when I deal with other things I promised to do in other Issues.

  • Yes
  • No
@vbuberen vbuberen added enhancement New feature or improvement to the library feature request Request a new feature to be developed labels Apr 6, 2020
@vbuberen vbuberen added this to the 3.3.0 milestone Apr 6, 2020
@cortinico
Copy link
Member

Here also link to the relevant discussion on Slack: https://kotlinlang.slack.com/archives/CRWD6370R/p1586167447028400

@vbuberen vbuberen self-assigned this May 21, 2020
@vbuberen vbuberen removed this from the 3.3.0 milestone Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or improvement to the library feature request Request a new feature to be developed
Projects
None yet
Development

No branches or pull requests

2 participants