azure-search-openai-demo icon indicating copy to clipboard operation
azure-search-openai-demo copied to clipboard

Fix samples browser

Open diberry opened this issue 9 months ago • 3 comments

Purpose

Does this introduce a breaking change?

When developers merge from main and run the server, azd up, or azd deploy, will this produce an error? If you're not sure, try it out on an old environment.

[ ] Yes
[ ] No

Does this require changes to learn.microsoft.com docs?

This repository is referenced by this tutorial which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial, check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.

[ ] Yes
[ ] No

Type of change

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

Code quality checklist

See CONTRIBUTING.md for more details.

  • [ ] The current tests all pass (python -m pytest).
  • [ ] I added tests that prove my fix is effective or that my feature works
  • [ ] I ran python -m pytest --cov to verify 100% coverage of added lines
  • [ ] I ran python -m mypy to check for type errors
  • [ ] I either used the pre-commit hooks or ran ruff and black manually on my code.

diberry avatar May 19 '24 12:05 diberry

Check Broken Paths

We have automatically detected the following broken relative paths in your files. Review and fix the paths to resolve this issue.

Check the file paths and associated broken paths inside them. For more details, check our Contributing Guide.

File Full Path Issues
./samples/document-security/README.md 1. ../app/backend/prepdocs.py

github-actions[bot] avatar May 19 '24 12:05 github-actions[bot]

I was thinking that the approach is:

  • Move the current TOC in docs/readme.md into the main readme.md, at the bottom under a section called "Additional documentation", with a link in the TOC at the top to that as well.
  • Copy the frontmatter and the updated readme.md into docs/readme.md

pamelafox avatar May 19 '24 14:05 pamelafox

@pamelafox Arun wants all 4 building blocks to appear in the samples browser. Only a readme is ingested so each building block needs its own readme in a separate subdir. If you can think of a different way to accomplish the same goal, go for it.

diberry avatar May 19 '24 15:05 diberry