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

Add more courses #24

Open
James-Livesey opened this issue May 3, 2022 · 3 comments
Open

Add more courses #24

James-Livesey opened this issue May 3, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@James-Livesey
Copy link
Member

There's only two courses in the help guide so far. It would be great to have more courses on some of the other aspects of atto, too!

One example of a course to write is how to make subroutines using gosub/return.

@James-Livesey James-Livesey added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 3, 2022
@WhenOkabeMetSubaru
Copy link

I would like to contribute can you guide me on this

@James-Livesey
Copy link
Member Author

Hi @HardikxLabeitazer, you're very welcome to contribute! Have you got any general ideas about a course you'd like to make?

How to make a course

Current documentation resides in the docs/courses folder in the main directory. You'll see that there already a few courses in there, along with index.md, which is the course list.

Simply write a course in the docs/courses folder following the general style of the existing courses — for example:

  • The first line of each course's source code starts with a paginator (such as [Guide](/index.md) 🢒 [Courses](/courses/index.md) 🢒 **Making an interactive chatbot**), so be sure to include that.
  • Any solutions to questions/code problems (if applicable) are wrapped in <details> elements — that way, there's no spoilers!

As for linking the courses together, the current last course (chatbot.md) should have the following appended to the bottom:

---

Completed the course? Move onto the next one!

<a href="/courses/nextcourse.md" class="card">Insert next course name here 🢒</a>

Finally, index.md should include the new course below the others — it should be pretty self-explanatory as to how to style that in the document.

Let me know if you need any further help, and feel free to make a pull request once you've finished, and I'll be happy to take a look!

@James-Livesey
Copy link
Member Author

Hey @HardikxLabeitazer, have you had much progress with regards to writing courses? Just that I'm considering about writing some courses myself too, and I don't want to end up writing any courses that cover the same stuff as what you've been working on!

Totally fine if you've been busy but are still planning to write a course, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants