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
docs: docs update and overhaul #434
Conversation
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.
@manekinekko and others involved with the project from the start will need to look at some of the specifics in this PR more closely, but from a higher-level I think this provides a solid update to help people understand the project more and get them to resources.
The Contoso Real Estate application can be integrated with an AI support chatbot built using [Azure OpenAI](https://azure.microsoft.com/products/ai-services/openai-service). | ||
|
||
For more details about enabling the chatbot integration, see [this section](./docs/chatbot-integration.md). | ||
The project has a standalone [Developer Guide](./packages/docs/website/README.md) defined under `packages/docs` and implemented as an interactive website using the [Docusaurus](https://docusaurus.io) platform. To learn more about it, [go here](./packages/docs/website/developer-guidelines.md). |
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.
Good addition. We'll try to get this moved into Training modules in the near future so the content is on a 1P resource and more discoverable.
|
||
[Additional details about what the Contoso Real Estate app is and what it does from a high-level – possibly has some images from the running app]. | ||
|
||
### Supported App Scenarios |
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.
This is really nice to have for devs first viewing the repo. I see 8 scenarios in the diagram and scenarios docs (https://30daysof.github.io/contoso-real-estate/intro/) though but only 5 here. Do we want this overview to match up with the scenario docs?
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.
FYI, scenario 7 (Redis Caching) has been deprioritized and hasn't been implemented yet.
## Steps to enable the service | ||
|
||
1 - Create a Web PubSub For Socket.IO resource. | ||
Click key tab in resource portal, copy connection string. | ||
|
||
2 - Rename .env.example under packages/realtime/ to .env. Then fill in copied connection string to variable WebPubSubConnectionString | ||
|
||
3 - Copy the endpoint part in connection string (e.g. https://<resource-name>.webpubsub.azure.com). And use it replace the default endpoint in packages/portal/src/app/shared/realtime.service.ts:L14 | ||
Follow original README to go on. |
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.
FYI, these manual steps are temporarily required untill we add Bicep/azd support for Web PubSub.
7be59df
When completed closes [Docs] overhaul and update all docs and diagrams #433