Planning docs design - Different flows suit different kinds of visitor [WIP]

[joshring]

As a visitor I Want to have a quick look at see if it is worth looking further

• Does the language match my philosophy?
• Does the language match my priorities?
• Does the language solve my problems? Or match my domain?
• What can I (already) do with C3?
  • What system library functions are available?
  • What external libraries are available?

How do I get set up?

• Installation of C3
• Online toolchains eg https://learn-c3.org/
• LSP, highlighting, editor integrations

I'm sold on C3 as a concept, I want to progress through the documentation show me the key features

I have programmed before in Javascript, Python, Go, Kotlin, Java or C#.

• Learning by examples.
• Learning by reading the documentation of the key features.
• Learning by guided building of a project scaffolding eg
  https://github.com/rust-lang/rustlings
  https://codeberg.org/ziglings/exercises
  https://github.com/functional-koans/clojure-koans
• Low friction access to a compiler toolchain like: https://learn-c3.org/
• Language Tours: https://go.dev/learn/
• Language in 10 minute videos: https://www.youtube.com/watch?v=C8LgvuEBraI
• Answer common questions:
  • How do I work with String and DString? how are they different and why
  • How do I read binary data into a struct?
  • How do I allocate memory dynamically?
  • What are temporary allocators?
  • How can I return from a temporary allocator's pool block?
  • How do I get started with raylib?

I'm sold on C3 as a concept, I have not programmed before.

• Conceptual understanding of a computer and memory
• Relate language features to conceptual understanding
• Guided learning curriculum with integrated low friction access to a compiler toolchain like: https://learn-c3.org/
• Codeacademy might be a good inspiration for something like this
  • https://www.codecademy.com/learn/learn-python-3
  • https://www.codecademy.com/learn/paths/c
• Language Tours: https://go.dev/learn/
• Language in 10 minute videos: https://www.youtube.com/watch?v=C8LgvuEBraI

[Caleb-o]

I enjoy the idea of opening the docs more to everyone. Having different directions and resources to help them learn the way they do, will definitely help bring people of diverse backgrounds in. I would be super keen for something like a C3lings, small project based learning (like the Rust book) and potentially video content. This sounds like a great foundation to me!

[joshring]

Currently getting the docs to be easier to navigate and easier to solve:

• Does the language match my philosophy?
• Does the language match my priorities?
• Does the language solve my problems? Or match my domain?
• Installation of C3

[joshring]

Currently getting the docs to be easier to navigate and easier to solve:

• Does the language match my philosophy?
• Does the language match my priorities?
• Does the language solve my problems? Or match my domain?
• Installation of C3

I think this initial phase of the redesign is complete now

I have started on some more beginner friendly content, so far looking at structs alignment and how that interacts with CPU cache lines, arrays and pointers are both planned as well