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

README Overhaul #3

Merged
merged 17 commits into from
Nov 30, 2023
Merged

README Overhaul #3

merged 17 commits into from
Nov 30, 2023

Conversation

Scienfitz
Copy link
Collaborator

@Scienfitz Scienfitz commented Nov 28, 2023

NOTE:

  • Badges will only work flawless after going public
  • Banner image in README will only work after this branch is merged (and possibly repo also needs to be public)

Included:

  • Moved telemetry explanations to telemetry.py
  • Added logo and banner images
  • Added header image to README
  • Added badges
  • Intro and feature appraisal
  • Reduced quick start example

Missing

  • Correct all links (possible also later)

@Scienfitz Scienfitz self-assigned this Nov 28, 2023
_typos.toml Outdated Show resolved Hide resolved
@Scienfitz Scienfitz requested review from AdrianSosic and AVHopp and removed request for AdrianSosic and AVHopp November 28, 2023 17:29
@Scienfitz Scienfitz changed the title DRAFT: README Overhaul README Overhaul Nov 28, 2023
@AdrianSosic
Copy link
Collaborator

General issue: I still can't build the documentation, which means that I also cannot verify how things are rendered. I think we need to fix this urgently, because only then we can properly review the open PRs. @AVHopp: can you open a mini-PR that contains the necessary fix so that we can merge it first?

CHANGELOG.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Collaborator

@AdrianSosic AdrianSosic left a comment

Choose a reason for hiding this comment

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

Hi @Scienfitz, thanks for reorganizing the file, looking gucci!! Have added a few minor comments (and will add one more in a minute) but overall this is a good welcome page for Github now! Also, I've pushed one commit with some minor fixes - please double check and let me know if you disagree!

baybe/telemetry.py Outdated Show resolved Hide resolved
@AVHopp
Copy link
Collaborator

AVHopp commented Nov 29, 2023

General issue: I still can't build the documentation, which means that I also cannot verify how things are rendered. I think we need to fix this urgently, because only then we can properly review the open PRs. @AVHopp: can you open a mini-PR that contains the necessary fix so that we can merge it first?

(Is it not possible to just answer to normal comments?!?) I'm on it. What error are you getting exactly (just out of curiosity)?

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@Scienfitz Scienfitz force-pushed the repo/README_overhaul branch from 8acfbd5 to 9271d1b Compare November 29, 2023 13:57
@CLAassistant
Copy link

CLAassistant commented Nov 29, 2023

CLA assistant check
All committers have signed the CLA.

@Scienfitz Scienfitz force-pushed the repo/README_overhaul branch from ced6757 to e75049a Compare November 29, 2023 14:06
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
baybe/telemetry.py Outdated Show resolved Hide resolved
@Scienfitz Scienfitz force-pushed the repo/README_overhaul branch from d76234a to f3e2e2f Compare November 29, 2023 16:20
AdrianSosic
AdrianSosic previously approved these changes Nov 29, 2023
@AdrianSosic AdrianSosic requested a review from AVHopp November 29, 2023 19:42
@AdrianSosic AdrianSosic merged commit b81776d into main Nov 30, 2023
8 checks passed
@AdrianSosic AdrianSosic deleted the repo/README_overhaul branch November 30, 2023 07:35
@AdrianSosic AdrianSosic added the documentation Improvements or additions to documentation label Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants