Skip to content

Create a Standardized Template for Cookbook Chapters #287

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

Closed
Likith-Yadav opened this issue Mar 28, 2025 · 1 comment
Closed

Create a Standardized Template for Cookbook Chapters #287

Likith-Yadav opened this issue Mar 28, 2025 · 1 comment

Comments

@Likith-Yadav
Copy link

Summary: Proposing a structured template for all chapters.

Why: Ensures consistency and easier contributions.

Proposed Format:


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:

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


@melissawm
Copy link

Duplicate of #282

Please contribute in one single issue, not need to open new ones with the same content. Thanks

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

No branches or pull requests

2 participants