Skip to content

Conversation

@rzo1
Copy link
Contributor

@rzo1 rzo1 commented Nov 6, 2025

This PR aims to migrate our documentation from the wiki to a dedicated code module, enabling faster updates and streamlined review cycles, which the wiki currently doesn’t support.

  • Most pages have been automatically converted from wiki Markdown to AsciiDoc format.
  • Additional pages have been added to simplify getting started with StormCrawler as well as an architectural outline with a basic image.
  • Documentation is packaged as a .tar.gz, allowing it to be deployed to Maven and used as versioned living documentation on the website.
  • Disables Wiki in GitHub
  • A live deployment of the documentation is available here: https://zowalla.com/stormcrawler/ (for better readability)

@rzo1 rzo1 marked this pull request as ready for review December 15, 2025 19:29
@rzo1 rzo1 changed the title Draft: #1542 - Migrate Documentation from Wiki to Living Documentation in Code #1542 - Migrate Documentation from Wiki to Living Documentation in Code Dec 15, 2025
@rzo1 rzo1 added this to the 3.5.1 milestone Dec 15, 2025
Copy link
Contributor

@sebastian-nagel sebastian-nagel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @rzo1! Looks good!

Regarding the figure: maybe change the direction of the arrow from FrontierSpout to Frontier. I understand: it's a request or "pull", but the data flow is the other direction.

@rzo1
Copy link
Contributor Author

rzo1 commented Dec 18, 2025

Thanks for the review @sebastian-nagel - I have fixed the issues, links and adjusted the image (and update the preview) :)

@sebastian-nagel
Copy link
Contributor

Thanks, @rzo1! Great work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants