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/Pre v1 propose refactor #992

Merged
merged 157 commits into from
Sep 21, 2023
Merged

Docs/Pre v1 propose refactor #992

merged 157 commits into from
Sep 21, 2023

Conversation

jlnav
Copy link
Member

@jlnav jlnav commented Apr 6, 2023

Addresses #1012

There's a couple ideas I'd like to address, primarily for beginning users:

  • Make small, simple code samples viewable as soon as possible
  • Flexibility is important, but shouldn't supersede ease-of-use or ease-of-initial-understanding
  • Is it possible to avoid this common docs pitfall: "if doing this, then this, if doing that, do that, if doing this with some of that do part of this and that."
  • Show one simple way of doing something first, then alternatives come later

@jlnav jlnav changed the title Docs/prev1 propose refactor Docs/Pre v1 propose refactor Apr 13, 2023
docs/programming_libE.rst Outdated Show resolved Hide resolved
@jlnav jlnav merged commit 9f4f61c into develop Sep 21, 2023
12 of 13 checks passed
@jlnav jlnav deleted the docs/prev1_propose_refactor branch September 21, 2023 18:28
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.

4 participants