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.

Sign up for GitHub

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

Jump to bottom

Feat: Rewrite Readme #35

Merged
merged 18 commits into from
May 25, 2023
Merged

Feat: Rewrite Readme #35

merged 18 commits into from
May 25, 2023

Conversation

NanoCode012
Copy link
Collaborator

@NanoCode012 NanoCode012 commented May 21, 2023 •
edited
Loading

Goal:

  • Simplify Readme and how to start
  • Collapse full yaml
  • Explain all config options
  • Explain all dataset types
    • main
    • dev (add warning in dev only) [closed to add later]
  • Collapse dataset types
  • (closed) Consider convert to Wiki style to debloat Readme?
  • Add faq for basic errors
  • Add link to issues and pr
  • Add image
  • Add badges [closed due to no useful badge]
  • Update first look

@NanoCode012 NanoCode012 marked this pull request as ready for review May 25, 2023 00:54
winglian
winglian approved these changes May 25, 2023
View reviewed changes
Copy link
Collaborator

@winglian winglian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is AMAZING. thanks!

@winglian winglian merged commit 6e7d4d5 into axolotl-ai-cloud:main May 25, 2023
@NanoCode012 NanoCode012 deleted the update-readme branch May 25, 2023 01:46
@unknown-submitter-000 unknown-submitter-000 mentioned this pull request Nov 1, 2023
Closed
8 tasks
mkeoliya pushed a commit to mkeoliya/axolotl that referenced this pull request Dec 15, 2023
@winglian
Merge pull request axolotl-ai-cloud#35 from NanoCode012/update-readme
59a97d4 
Feat: Rewrite Readme
djsaunde pushed a commit that referenced this pull request Dec 17, 2024
@winglian
Merge pull request #35 from NanoCode012/update-readme
57d593f 
Feat: Rewrite Readme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@winglian winglian winglian approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NanoCode012 @winglian