TODO: Learn page

[caffeine-addictt]

Feature Request

Your issue may already be reported! Please check out our active issues before creating one.

Is Your Feature Request Related to an Issue?

Thread may appear overly confusing to use, especially for those unfamiliar with python's built-in threading library. At present, there is no examples for usage of thread, providing these examples can help guide first-time developers.

Describe the Solution You'd Like

A '/learn' or equivalent route should be created to provide easy-to-follow and heavily documented examples for using thread.

• [ ] Learn python threading module
• [ ] Learn thread package
• [x] Threading examples page
• [x] Parallel Processing examples page
• [x] Cautions pages

[ShiroTohu]

Just a thought that I had in passing. Instead of an examples/ route we could implement a learn/ route instead that covers the basics of the python thread module and the thread module. Next.JS utilizes this same approach and I quite liked it when I was learning Next.JS for the website. What's also nice about it is that it covers React as well which reduced the knowledge of entry! so I think it could work wonderfully here as well.

See what I am talking about here.

I could also add a quiz component like seen in Next.JS course!

A '/examples' or equivalent route should be created to provide easy-to-follow and heavily documented examples for using thread.

We can probably cover more heavy concepts in the actual documentation for people more familiar with the base library and the utilities thread provides. We could probably put it under a sub-folder called examples or pair it with the relative methods, whichever is more convenient for reader.

What do you think?

[caffeine-addictt]

Just a thought that I had in passing. Instead of an examples/ route we could implement a learn/ route instead that covers the basics of the python thread module and the thread module. Next.JS utilizes this same approach and I quite liked it when I was learning Next.JS for the website. What's also nice about it is that it covers React as well which reduced the knowledge of entry! so I think it could work wonderfully here as well.

Ah! I didn't think of that. Yes, I agree this would be a better approach. I'll update the initial issue.

We can probably cover more heavy concepts in the actual documentation for people more familiar with the base library and the utilities thread provides. We could probably put it under a sub-folder called examples or pair it with the relative methods, whichever is more convenient for reader.

I guess it would make more sense to keep the examples simple. We could instead provide links to the more in-depth documentation.

Perhaps something of this structure?

/
  -> /about
  -> ...
  -> /learn
      -> /[slug] (Links to [/slug])
  -> /[slug]

[ShiroTohu]

I guess it would make more sense to keep the examples simple. We could instead provide links to the more in-depth documentation.

Yep! I think that idea. As for the structure you mentioned, take a look at the example pages below.

---

[!IMPORTANT]
Just want to point out that the documentation will not look like the second picture of course. Just a placeholder :)

[caffeine-addictt]

Yea! I believe we are on the same page 👍🏻

[caffeine-addictt]

Which library are you using for syntax highlighting? react-syntax-highlighter/prisma?

[ShiroTohu]

Which library are you using for syntax highlighting? react-syntax-highlighter/prisma?

I'm unsure how to find out.

I haven't touched anything pertaining to syntax highlighting on my end. So I don't really know what to look for.

[caffeine-addictt]

Ah!! I see.

[caffeine-addictt]

I'm thinking we should still include a /learn/examples route, but just have it be for getting a quick-start.

This way, we could encapsulate all the examples and learning within /learn without a /getting-started etc.

Something like this perhaps?

/
  -> ...
  -> /learn
      -> /examples
          -> /[slug]
      -> /[slug] (Links to [/slug])
  -> /[slug]

A mockup of what I have so far

[caffeine-addictt]

I'll go ahead and abstract the cautions to its own /learn/cautions page.