Skip to content

Write Tutorials for Each Step of Souza-Junior's Method Following Divio Documentation Principles #64

Open
@YagoMCastro

Description

@YagoMCastro

Following the principles established by the Divio Documentation System, we need to create tutorials that guide users through each step of Souza-Junior's method individually. At the end, we should also provide a comprehensive tutorial demonstrating how to apply the entire method from start to finish.

Tasks:

  • Write a tutorial about how to read QDM data
  • Write a tutorial about how to generate a model
  • Write a tutorial about how to run the detection algorithm
  • Write a tutorial about how to run the position estimation algorithm
  • Write a tutorial about how to run the magnetic moment estimation algorithm
  • Implement a tutorial for the full method presented by Souza-Junior

Guidelines:

  • Structure each tutorial clearly following Divio’s standards: practical, goal-oriented, showing how to accomplish a specific task.
  • Keep instructions sequential and beginner-friendly.
  • Include code examples, screenshots, and tips where appropriate.
  • The full tutorial should reference the step-by-step tutorials but also be able to stand alone.

Additional Notes:

  • Make sure all tutorials are consistent in style and terminology.
  • Link between the individual tutorials and the full workflow where relevant.
  • Prefer short and clear sentences to improve accessibility.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions