Added high-level README files - #1037
Open
sujaykarmakar wants to merge 1 commit into
Open
Conversation
Contributor
|
That is what package level Javadoc is for. |
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
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 adds package-level
README.mdfiles for the following core Tomcat packages:java/org/apache/catalina/README.mdjava/org/apache/coyote/README.mdjava/org/apache/tomcat/util/README.mdWhat’s included
Each README provides a high-level overview of the package, including:
Motivation
While Tomcat has comprehensive Javadocs and architecture documentation, it can take some time for new contributors to understand the role of each package when navigating the source tree. These READMEs are intended to serve as quick entry points and improve codebase discoverability without duplicating existing documentation.
Impact