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

Add Wiki page #13

Closed
thagikura opened this issue May 6, 2016 · 10 comments
Closed

Add Wiki page #13

thagikura opened this issue May 6, 2016 · 10 comments

Comments

@thagikura
Copy link
Contributor

Such as use cases where FlexboxLayout is more beneficial than other existing layouts.

@shivasurya
Copy link

really useful - to build bus seat booking apps,theatre bookings and even more 👍

@thagikura
Copy link
Contributor Author

@lii2
Copy link

lii2 commented Jun 8, 2016

I'd be interested in bettering the documentation. Is it okay if I submit requests to edit the wiki?

@thagikura
Copy link
Contributor Author

@lii2 Wow, thank you for the offer! It's more than welcome!

AFAIK, there isn't an official way to make a PR for wiki pages on GitHub.
I found the best answer of this Stack Overflow thread looks good.
Is it okay to follow that way, or do you have any other preferred way?

@lii2
Copy link

lii2 commented Jun 9, 2016

I'll test it out.

@lii2
Copy link

lii2 commented Jun 9, 2016

As a test, I've added a Table of contents to the Target use case page. Here is the wiki repository I've created, try merging the repo with the wiki repo.

https://github.com/lii2/flexbox-wiki

@thagikura
Copy link
Contributor Author

Thanks! The repository structure looks good.
As for the table of contents, I think adding a custom sidebar looks better and easier to navigate like the agera Wiki does.
How do you think? (Tried creating it as a proof of concept https://github.com/google/flexbox-layout/wiki)

Also in the next time, when you change the wiki page in your repository, adding an issue to the flexbox-layout repo (this repo) to request to merge the change seems good like explained in the SO thread
That way, your contribution will be visible on GitHub I'd prefer it.

@lii2
Copy link

lii2 commented Jun 10, 2016

Yes, I can open a new issue when I change stuff. Also, I suggest moving a lot of the stuff in the Readme (particularly the in-depth stuff about supported attributes + gifs and usage) into a seperate wiki page.

I can also write a short tutorial on using flexbox in android studio for the wiki.

@thagikura
Copy link
Contributor Author

Thanks, please open a new issue when you make a change.

I suggest moving a lot of the stuff in the Readme (particularly the in-depth stuff about supported attributes + gifs and usage) into a seperate wiki page.

I think the current README doesn't describe the in-depth stuff for the supported attributes. (only the introduction)
And I'd like to keep such a basic introduction for the supported attributes in the most visible place (in README) if you don't have a strong opinion for that.

@thagikura
Copy link
Contributor Author

Closing this. Filed different issues #84 #85 for ideas for the wiki pages improvement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants