Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Improve documentation #115

Open
AlirezaIvaz opened this issue Mar 24, 2022 · 4 comments
Open

Improve documentation #115

AlirezaIvaz opened this issue Mar 24, 2022 · 4 comments

Comments

@AlirezaIvaz
Copy link
Contributor

I would like to expand the documentation but unfortunately I don't have the necessary access.
The most important thing I want to add to the documentation are practical examples that users may not be able to easily find in the demo source.
If you're not sure, I can do some of these things in my fork and show you.

@Yanndroid
Copy link
Member

Yeah good idea, you can clone the wiki locally https://github.com/Yanndroid/OneUI-Design-Library.wiki.git if you want and send me the edited files. Unfortunately I won't have time for the library in the coming 2 months, due to exams. But after that, the library will be moved here with a lot of changes.

@salvogiangri
Copy link
Member

Thank you a lot for your interest in this project. We are currently working on the new iteration of the lib (progress are slow since both me and @Yanndroid are extremely busy lately), so I personally suggest you to give a look at that one instead (want to avoid you spending time on this since it will probably be replaced by the new one). If you are interested, here's the link of the repo: sesl-appcompat.
To sum it up: the new library will be completely different from the current one, instead of being an addon, we are now replacing completely Google AndroidX modules with Samsung ones, this allows us to:

  • Use separated modules instead of having one with everything, same as the classic AndroidX library, in this way we can patch out single modules instead of releasing new versions of an entire lib (you also can now decide which module to implement in your app instead of having them all);
  • Free up some space in the apks by not having unused Google stuff or duplicated classes;
  • Easier to code apps since all the stuff is now 100% same as Google AndroidX except for the new features implemented by Sammy (You basically will now use androidx.* stuff instead of ours, for the most part)

There are more advantages, but onestly these are the only three reasons I have in mind rn (I'm pretty tired atm, just got home from work)😅. We are also working on implementing new stuff that is missing in this lib+bug fixes (stuff such as Time/DatePickers that are currently in the dev branch of this repo, BottomNavigationView, NavigationRail etc.).

@salvogiangri
Copy link
Member

@AlirezaIvaz if you're still interested on enhancing the documentation, we are currently working on the new libs' docs that will be published in our organization github pages, W.I.P. stuff can be found on my temp github pages. We're committing to document both sesl (the actual new One UI lib) and oneui-design (backported components of the old lib) libs

@AlirezaIvaz
Copy link
Contributor Author

@AlirezaIvaz if you're still interested on enhancing the documentation, we are currently working on the new libs' docs that will be published in our organization github pages, W.I.P. stuff can be found on my temp github pages. We're committing to document both sesl (the actual new One UI lib) and oneui-design (backported components of the old lib) libs

Yes of course, I will try to join this project as soon as possible.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

3 participants