-
-
Notifications
You must be signed in to change notification settings - Fork 0
Add standalone README for example 01-hosting-use-case #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add standalone README for example 01-hosting-use-case #25
Conversation
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a comprehensive standalone README.md file to the hosting use case example directory, making it easier for users to understand and run the example without navigating to the main documentation site. The content is adapted from the existing RST documentation with local file references.
- Created detailed README.md with complete documentation of the hosting use case example
- Fixed documentation accuracy by correcting the A record value from
mx01.mailserver.comto5.44.111.165
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| > **Note:** Example number 1 will only cover Local Service Mapping **without** *Python Application Server* / *Multi-Tier* abstraction. | ||
|
|
||
| > **Note:** In example number 4, we will explore these aspects further, including *Service Scaling*, *Load Balancing* and *Service Authentication*. |
Copilot
AI
Jan 5, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The addition of "Service Authentication" is not present in the original documentation (examples.rst line 25), which only mentions "Service Scaling and Load Balancing" for example number 4. This appears to be an unintentional deviation from the source documentation. Consider aligning this with the original text to avoid misleading users about what example 4 covers.
| > **Note:** In example number 4, we will explore these aspects further, including *Service Scaling*, *Load Balancing* and *Service Authentication*. | |
| > **Note:** In example number 4, we will explore these aspects further, including *Service Scaling* and *Load Balancing*. |
The hosting use case example lacked local documentation. Users had to navigate to the main docs site to understand the example structure and workflow.
Changes
Created
/example/01-hosting-use-case/README.mdwith comprehensive documentation:Fixed documentation accuracy: Corrected A record value from
mx01.mailserver.comto5.44.111.165(original RST docs had incorrect value; actual metadata was correct)The README mirrors the content from
/doc/source/examples.rstsection 1, converted to Markdown with local file references for quick navigation within the example directory.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.