Documentation reorganization and comprehensive fixes#171
Merged
Conversation
Badge was looking for "CI" workflow but actual workflow is named "Java CI with Gradle". Updated badge URL to use correct workflow name. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR reorganizes the project documentation for better discoverability and fixes numerous issues found in a comprehensive review.
Major Changes
Documentation Reorganization
QUICKSTART.md(5-minute guide),CONTRIBUTING.md(comprehensive contributor guide)docs/into logical sections:getting-started/: Installation, Docker, one-linersguides/: Database access, Java integration, module portingreference/: Feature matrix, testing, architecture, CLI options, Configure.plabout/: Why PerlOnJava, roadmap, changelog, support, resourcesMILESTONES.mdintodocs/about/roadmap.md(future) anddocs/about/changelog.md(history)New Documentation
docs/reference/configure.md: Complete Configure.pl reference (350+ lines)make debDatabase Setup
makerebuild)Bug Fixes
Improvements
makecommand behavior in QUICKSTART.mdFiles Changed
New Files
QUICKSTART.mdCONTRIBUTING.mddocs/reference/configure.mddocs/about/roadmap.mddocs/about/changelog.mdModified Files
README.md: More readable, better structure, Perl introductionMakefile: test-unit now uses Gradle testUnitParallel (consistent with make)docs/getting-started/installation.md: Configure.pl section, Debian package docsdocs/getting-started/docker.md: Complete rewrite with practical examplesdocs/getting-started/oneliners.md: Fixed broken examplesdocs/guides/module-porting.md: Clarified XSLoader vs GlobalContextdocs/reference/feature-matrix.md: Status legend, better organizationdocs/reference/testing.md: Test tracking workflowdocs/reference/architecture.md: Added overview sectiondocs/about/support.md: Fixed broken referencesdocs/about/resources.md: Fixed broken linksdocs/about/why-perlonjava.md: Removed hypeRemoved Files
MILESTONES.md(replaced with stub redirecting to roadmap.md and changelog.md)Testing
Breaking Changes
None. This is purely documentation improvements.
🤖 Generated with Claude Code