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

Revamp documentation resources #54

Merged
merged 8 commits into from
Mar 21, 2024

Conversation

natsukagami
Copy link
Contributor

Most documentations live in /docs now, with a landing page at https://lampepfl.github.io/gears
linking to them.

README now is a simple page showing build status, release, basic build instructions etc.

  • Move Bartosz's report to its own directory
  • Move Martin Odersky's talk and README to docs
  • Add Maximilian's report
  • Add landing page
  • Add a simple README

@natsukagami natsukagami marked this pull request as ready for review March 19, 2024 15:20
@m8nmueller
Copy link
Contributor

I wonder what's the role of the README in this setup: Build instructions are in CONTRIBUTING and infos - or rather: links - are on the docs page. If the page didn't look as nice as it does, I would have voted for its deletion in favor of an elaborate README. But I guess it's fine, because it does look nice :)

Besides, I would add some "For an overview of the library, see..." which would be really important to be in the docs imho. We do have something like that: the release notes: https://github.com/lampepfl/gears/releases/tag/v0.1.0. Maybe we could copy/move them to the docs - and in any case keep them updated. Otherwise it's very hard to get started, given the reports, the Scala API, and the increasingly outdated Scalar README.

@amsen20
Copy link

amsen20 commented Mar 19, 2024

I think it would be better to have more parts on the README even if they are available somewhere else, the following are the parts I find useful:

  • An overview part describing the library's positive points compared to existing Scala async programming libraries (like structured concurrency and simplicity)
  • A "Getting Help"/"Where to Start" part with a link to the library main page in docs (I think it is essential)
  • An Example part explaining a quick example of how to add gears to a project and an example of simple code.

In my opinion, the README of the following pages looks fine to me and is similar to gears (in some way :D):

The page is great. I think the library is better to have its own logo :D

@natsukagami
Copy link
Contributor Author

Besides, I would add some "For an overview of the library, see..." which would be really important to be in the docs imho.

Would the book be sufficient in this case?

@natsukagami
Copy link
Contributor Author

Let's have this in first -- I think it's better to have a landing page first and foremost, better than nothing ;) We can improve it later.

@natsukagami natsukagami merged commit 7c033a3 into lampepfl:main Mar 21, 2024
3 checks passed
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