Skip to content

Reorganize repository into quick starts and deep dives #19

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alimaredia
Copy link
Contributor

Examples in the repository now fall into two
categories: deep dives and quick starts.

Update README.md to reflect new repo structure

Examples in the repository now fall into two
categories: deep dives and quick starts.

Update README.md to reflect new repo structure

Signed-off-by: Ali Maredia <[email protected]>
@JustinXHale
Copy link
Member

Thanks for putting this together @alimaredia and initiating this important reorganization.

I've reviewed the proposed changes, and I see strong alignment with the vision we've been discussing for the repo's IA and its goals of being an informative, useful resource for AI model customization. I particularly like the inclusion of model_customization_examples/, e2e_examples/, and community_examples/, as these are key categories for our content.

Building on this, I propose a few refinements to streamline the top-level Information Architecture and enhance user experience, especially for beginners:

  • Streamlined Top-Level: My suggestion is to remove the official_examples/ wrapper. If all notebooks we publish are vetted, this wrapper becomes redundant. I propose elevating the core categories directly to the root.
  • Explicit Onboarding: Introduce a 00_getting-started/ top-level directory. It establishes a clear, numbered entry point for a progressive learning path.
  • Refined Community: Keep 03_community-examples/, potentially with vetted/ and unvetted/ sub-sections.

This refined structure would look something like:

README.md
00_getting-started/
01_model-customization/
02_end-to-end-flows/
03_community-examples/

I've created a branch named repo-restructure which I will show this structure.

I'd be happy to discuss these refinements and walk you through the structure in my branch. Let me know what you think!

@JustinXHale
Copy link
Member

@alimaredia here is my branch
https://github.com/instructlab/examples/tree/repo-restructure

@anastasds
Copy link
Contributor

Is the latest work in the e2e notebook here? Printing randomly selected chunks and Q&A customization are not there. Are those intended to be deep dives? That would make sense to me.

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.

3 participants