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

Docs/mkdoc #1379

Draft
wants to merge 25 commits into
base: develop
Choose a base branch
from
Draft

Docs/mkdoc #1379

wants to merge 25 commits into from

Conversation

PGijsbers
Copy link
Collaborator

Work converting the Python docs to mkdocs. Left to do before it's "functional":

  • Make sure notebooks run
  • Add the test server warning back, preferably in a reusable way as was before.

Otherwise, most of the files have been converted.

That said, the documentation really needs a rewrite. I refrained from changing any content as much as I could, with rare exceptions. But the main problems, to me, are:

  • Information is all over the place. A few cohesive examples with a proper ToC would be better (I think).
  • The formatting is bad.
  • There is a mix of styles. Some examples even talk about "exercises" (e.g., here).
  • Some of the content is outdated.

How should we move forward with this PR? I don't mind rewriting (some of) this documentation, but I think it would be better to merge this at one point so it's easier to collaborate. WDYT? @eddiebergman @LennartPurucker

@LennartPurucker
Copy link
Contributor

IMO: merge first and focus on user stories/use cases afterward to refactor the documentation. That is, likely move all the old documentation to an "extended example" list and only keep a set of user stories / use cases in the new main documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants