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

Update Sector-Level Spell Design Documentation #7401

Closed
wants to merge 1 commit into from

Conversation

DeVikingMark
Copy link
Contributor

Description

This pull request updates the sector_spell_design.md file to enhance clarity and provide additional details about the structure and guidelines for sector-level spells in the Spellbook repository. The changes include:

  • Expanded introduction to highlight the importance and usage of sector-level spells like dex.trades and nft.trades.
  • Detailed structure overview for organizing sector-level spells, including directory conventions and upstream design considerations.
  • Improved cross-referencing with existing documentation, such as example DEX documentation.
  • General formatting adjustments for better readability.

Changes

  • File: docs/general/sector_spell_design.md
  • Modifications:
    • 16 additions
    • 1 deletion

Summary of Changes

  1. Clarified the scope and definition of sector-level spells.
  2. Added a structure overview for organizing raw data, chain-specific aggregations, and cross-chain unified views.
  3. Enhanced links to related resources for better navigation within the repository.

Motivation

These updates aim to align the sector-level spell documentation with the latest repository standards and practices. They improve understanding for contributors and maintainers, facilitating consistency across projects and sectors.


Checklist

  • Documentation updated to reflect new structure and conventions.
  • Links to relevant examples and resources verified.
  • Ready for review.

For further details, refer to:

Description

This pull request updates the sector_spell_design.md file to enhance clarity and provide additional details about the structure and guidelines for sector-level spells in the Spellbook repository. The changes include:

  • Expanded introduction to highlight the importance and usage of sector-level spells like dex.trades and nft.trades.
  • Detailed structure overview for organizing sector-level spells, including directory conventions and upstream design considerations.
  • Improved cross-referencing with existing documentation, such as example DEX documentation.
  • General formatting adjustments for better readability.

Changes

  • File: docs/general/sector_spell_design.md
  • Modifications:
    • 16 additions
    • 1 deletion

Summary of Changes

  1. Clarified the scope and definition of sector-level spells.
  2. Added a structure overview for organizing raw data, chain-specific aggregations, and cross-chain unified views.
  3. Enhanced links to related resources for better navigation within the repository.

Motivation

These updates aim to align the sector-level spell documentation with the latest repository standards and practices. They improve understanding for contributors and maintainers, facilitating consistency across projects and sectors.


Checklist

  • Documentation updated to reflect new structure and conventions.
  • Links to relevant examples and resources verified.
  • Ready for review.

For further details, refer to:

@github-actions github-actions bot marked this pull request as draft December 30, 2024 18:19
@github-actions github-actions bot added the WIP work in progress label Dec 30, 2024
Copy link

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request

@jeff-dude jeff-dude closed this Jan 2, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jan 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
WIP work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants