docs(azure-functions): replace template README with real documentation - #53
Open
vanshika2720 wants to merge 1 commit into
Open
docs(azure-functions): replace template README with real documentation#53vanshika2720 wants to merge 1 commit into
vanshika2720 wants to merge 1 commit into
Conversation
The azure-functions README was still the scaffold generated for new plugins, with every section left as an HTML-comment placeholder. Fill it in from the current implementation: overview, architecture, supported/unimplemented stages, plugin and application configuration, required environment, authentication, usage examples, troubleshooting, development, testing, and known limitations. Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
Author
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.
What this PR does
Replaces the Azure Functions plugin's scaffold README with implementation-backed documentation.
The new README documents the plugin architecture, supported deployment stages, deploy target and application configuration, authentication and environment requirements, usage examples, troubleshooting guidance, development workflow, testing, and known limitations based on the current implementation.
Why we need it / Without this PR, what is the problem?
The existing README was still the generated template, with placeholder sections and example values instead of actual documentation.
This made it difficult for users and contributors to understand how to configure, use, and develop the Azure Functions plugin. This PR replaces the placeholder content with documentation that reflects the current implementation without changing any functionality.