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 readme/microsite #118

Merged
merged 6 commits into from Jul 25, 2019
Merged

Conversation

dzanot
Copy link
Contributor

@dzanot dzanot commented Jul 18, 2019

Fixes #117

I just fixed for the current setup, but I have a feeling there's a better way to structure this though.
Maybe moving the tut readme into docs and having thing root readme just link to the microsite?

Copy link
Member

@pepegar pepegar left a comment

Choose a reason for hiding this comment

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

Thanks @dzanot

@pepegar
Copy link
Member

pepegar commented Jul 19, 2019

Regarding your question... I'm not completely sure. Currently we're using readme/README.md for both README.md in the root of the repo, and also for the index.md in docs.

Do you think we could enhance the process somehow?

@bilki
Copy link
Contributor

bilki commented Jul 19, 2019

I like the protobuf example but those definitions look kinda long compared to avro example, also it does not perform any typecheck with tut. Maybe we could use a reduced example, or go the other way and expand the avro example to match protobuf one?

@dzanot
Copy link
Contributor Author

dzanot commented Jul 19, 2019

@bilki for those examples, I didn't add them I just moved them from one readme to the tut readme.

I'll work on making it compile from tut

@dzanot
Copy link
Contributor Author

dzanot commented Jul 19, 2019

I've condensed the protobuf example to mirror the Avro. I'd like to make it a little more complex by adding a service definition but I'm going to have to tinker to get it to work on the avro side.

I've also trimmed down the root README, added a link to the microsite, and moved the examples into the docs submodule as index.md

Copy link
Contributor

@bilki bilki left a comment

Choose a reason for hiding this comment

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

Oh, sorry @dzanot, my fault, didn't know that proto example was already there. Now it looks simpler, more type-secure, and project structure is cleaner now 👍

Copy link
Member

@juanpedromoreno juanpedromoreno left a comment

Choose a reason for hiding this comment

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

Thanks @dzanot ! LGTM on green 👍

@dzanot
Copy link
Contributor Author

dzanot commented Jul 24, 2019

Happy to help, CI is all green but I don't have write permissions. Feel free to merge!

@juanpedromoreno juanpedromoreno merged commit e7c5677 into higherkindness:master Jul 25, 2019
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.

Tut readme out of sync
4 participants