Skip to content

docs: clarify crawl discovery plugin boundaries#762

Open
Vishvadharman wants to merge 4 commits into
utksh1:mainfrom
Vishvadharman:docs-clarify-crawl-plugin-family-544
Open

docs: clarify crawl discovery plugin boundaries#762
Vishvadharman wants to merge 4 commits into
utksh1:mainfrom
Vishvadharman:docs-clarify-crawl-plugin-family-544

Conversation

@Vishvadharman

Copy link
Copy Markdown
Contributor

Description

Clarifies the overlap between the crawl/discovery plugin family by documenting the purpose and boundaries of crawler, katana, spider, and sitemap_gen.

Changes include:

  • Updated plugin metadata descriptions to better reflect actual execution behavior
  • Clarified the differences between the four Katana-based discovery plugins
  • Added documentation describing intended use cases and execution differences
  • Updated catalog descriptions to reduce ambiguity for users
  • Documented that no plugins were renamed or merged as part of this change

Related Issues

Closes #544

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Reviewed plugin metadata for crawler, katana, spider, and sitemap_gen
  • Verified descriptions align with command templates and execution behavior
  • Confirmed documentation accurately reflects plugin boundaries and intended usage

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

@Vishvadharman Vishvadharman force-pushed the docs-clarify-crawl-plugin-family-544 branch from 6cf6f25 to d7c5884 Compare June 10, 2026 17:55
@Vishvadharman Vishvadharman force-pushed the docs-clarify-crawl-plugin-family-544 branch from 464ea15 to 326a7aa Compare June 10, 2026 18:04
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

Successfully merging this pull request may close these issues.

[PLUGINS] Clarify overlap across crawler, katana, spider, and sitemap_gen

1 participant