Create a Template for Writing Discover Cookbook Chapters

[seunolufemi123]

As we are working towards developing the third edition of the DISCOVER Cookbook, we want to write a template for contributing or writing new chapters to the DISCOVER Cookbook, this is to ensure consistency and ease of contribution.

[Likith-Yadav]

Hi, I’d love to contribute to this issue! Could you provide any specific format or guidelines you'd like the template to follow? Should it include sections for code examples, figures, or references? Looking forward to your guidance!

[Likith-Yadav]

okay , i have understood and here is a basic template that i have analysed so far

---

Chapter Title

1. Introduction

• Briefly introduce the topic and its significance.
• Provide context for why this chapter is important.

2. Learning Objectives

• Clearly state what readers will learn from this chapter.
• Example:
  • Understand the basics of time series forecasting
  • Learn how to use Aeon’s forecasting module

3. Prerequisites

• List any necessary knowledge or tools needed before starting.
• Example: Python, NumPy, Pandas, basic ML knowledge.

4. Step-by-Step Implementation

• Provide a structured explanation with code snippets and examples.
• Use proper Markdown formatting:

  import numpy as np  
  print("Hello, world!")  
  

This is a basic template I have analyzed so far. Let me know if any modifications or additional sections are needed!

[ghost]

Hi! I see that this issue is about creating a standardized template for cookbook chapters.
I’d love to contribute by refining the existing template with better markdown formatting, clearer section definitions, and any additional improvements that may be needed.
Let me know if I can proceed with these enhancements.

[ChehakTrehan]

Hii @seunolufemi123 please review my PR. I created the templated.
Thanks
Chehak

[AR21SM]

Hi @aterrel , @melissawm ,
Could you please take a look and let me know if it aligns with your expectations or if there are any changes you'd suggest? I'm happy to make any adjustments needed. Thanks!

✅ PR Checklist for DISCOVER Cookbook Contributions

Before submitting your Pull Request (PR), please confirm that you've completed the following:

Contribution Type

• Content addition or chapter update
• Design improvement or accessibility fix
• Documentation update (README, CONTRIBUTING, etc.)
• Bug fix (non-content)
• Other (please describe): ___________________________

Idea Approval

• I started with a discussion on the Discussions tab and received community or maintainer approval.

• An issue was created and approved before this PR (link it below).

  • Issue reference: #______

Local Development

• I have cloned the repo and created a new feature branch.
• I built the book locally using the build instructions and verified the changes.

Pre-Submission Tasks

• I have written clear, concise commit messages using the conventional format outlined in CONTRIBUTING.md.
• My PR includes necessary references, links to resources, or related discussions.

📝 Description of the Pull Request

[aterrel]

@AR21SM yes that is fine are you wanting to make a template for PRs?

I know this issue was more on the lines of, "How do I write a chapter". There isn't a formal template for either but this seems reasonable for PRs.

[AR21SM]

@AR21SM yes that is fine are you wanting to make a template for PRs?

I know this issue was more on the lines of, "How do I write a chapter". There isn't a formal template for either but this seems reasonable for PRs.

I think we can make two of them , one for PR review and one for writing chapters(focused on structure: Tittle, Content objectives ,references etc )

---

Give me some time , I’ll work on it and create a PR soon