Skip to content
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

fix: re-factoring the website so that the links to notebooks do not appear on two pages. #774 #789

Closed
wants to merge 3 commits into from

Conversation

rabbabansh
Copy link
Collaborator

@rabbabansh rabbabansh commented Nov 28, 2023

Why are these changes needed?

Added a common .md file for Examples, and then referenced it in both Use Cases and Examples to make it easier foir any contributor to edit once.

Related issue number

Closes #774

Checks

@rabbabansh
Copy link
Collaborator Author

@sonichi @olaoluwasalami

@olaoluwasalami
Copy link
Collaborator

@qingyun-wu

@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8d5f176) 27.79% compared to head (a15a440) 27.79%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #789   +/-   ##
=======================================
  Coverage   27.79%   27.79%           
=======================================
  Files          27       27           
  Lines        3497     3497           
  Branches      793      793           
=======================================
  Hits          972      972           
  Misses       2454     2454           
  Partials       71       71           
Flag Coverage Δ
unittests 27.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qingyun-wu
Copy link
Contributor

@rabbabansh thanks for the contribution. I believe this issue has been resolved in a separate PR adding an example and ecosystem page. Could you please check the latest website: https://microsoft.github.io/autogen/docs/Examples and refer to this page when a reference to the examples is needed? Thank you!

@rabbabansh
Copy link
Collaborator Author

rabbabansh commented Nov 30, 2023

I believe this issue will still persist because there are still references to the same set of examples in both docs/Use-Cases/agent-chat.md as well as docs/examples.md, so changing/updating one set of examples will leave the other one out of date in either of the two pages, since many developers forget to update both as mentioned in #772

Although my approach is quite similar to this structure, should I update this PR to accomodate this new structure and store all the examples in the docs/examples.md file and import them from examples.md to the Use-Cases/agent-chat.md page?

@qingyun-wu
Copy link
Contributor

Closing this PR as the problem is already resolved! Thank you!

@qingyun-wu qingyun-wu closed this Dec 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

re-factoring the website so that the links to notebooks do not appear on two pages
4 participants