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.

Sign up for GitHub

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

Jump to bottom

Move documentation to GitHub Pages #32

Closed
RaddishIoW opened this issue May 21, 2021 · 1 comment
Closed

Move documentation to GitHub Pages #32

RaddishIoW opened this issue May 21, 2021 · 1 comment
Assignees
@RaddishIoW
Labels
documentation Improvements or additions to documentation

Comments

@RaddishIoW
Copy link

It would be good to get the rather long README.md and other docs into a better layout, probably using GitHub pages.

The README.md should just include a quick intro, relevant details on installing and quick setup. Any further details should be broken out into their own documents.

We should make a FAQ too - there's a few things in the README.md that would make FAQ points.
@RaddishIoW RaddishIoW added the documentation Improvements or additions to documentation label May 21, 2021
@RaddishIoW RaddishIoW self-assigned this May 21, 2021
@HarelM
Copy link
Collaborator

HarelM commented May 21, 2021

I agree with everything you wrote :-)
Let me know if and how I can help.
We may consider using the wiki too if github pages are annoying to maintain...

HarelM added a commit that referenced this issue Jun 27, 2021
@HarelM @RaddishIoW
Version 1.1 - Merge develop into stable (#43)
188241d 
* Set theme jekyll-theme-hacker

* Update Changelog

* docs: move to github pages (#35)

Fixes #32

* Update Changelog

* Adds promises and subscription (#36)

Resolves #16 

* Add promises and subscription to js interface #16 - initial commit

* #16 - fix subscriable interface

* bump version, fix docs

* fix incorrect link

* Update Changelog

* build: add workflow to automatically merge to stable on release (#42)

* Update Changelog

* GPS transactional location fetch (#38)

* [Feature] Transaction-based access to the GPS positions buffer #18 - initial commit

* [Feature] Transaction-based access to the GPS positions buffer #18 - fixes incorrect calls and missing facade and js code

* [Feature] Transaction-based access to the GPS positions buffer #18 - Fix compilation

* [Feature] Transaction-based access to the GPS positions buffer #18 - Add typesript definitions

* [Feature] Transaction-based access to the GPS positions buffer #18 - Fix iOS compilation and typo

* [Feature] Transaction-based access to the GPS positions buffer #18 - Fix iOS compilation

* [Feature] Transaction-based access to the GPS positions buffer #18 - Add missing import

* Update documentation and allow using promise.

* Update Changelog

Co-authored-by: Adam Radestock <[email protected]>
Co-authored-by: RaddishIoW <[email protected]>
Co-authored-by: HarelM <[email protected]>
HarelM added a commit that referenced this issue Oct 1, 2021
@HarelM @RaddishIoW
Add support for AndroidX (#49)
7fd6f94 
* Set theme jekyll-theme-hacker

* Update Changelog

* docs: move to github pages (#35)

Fixes #32

* Update Changelog

* Adds promises and subscription (#36)

Resolves #16 

* Add promises and subscription to js interface #16 - initial commit

* #16 - fix subscriable interface

* bump version, fix docs

* fix incorrect link

* Update Changelog

* Support AndroidX #15 - main commit

* Bump version, update readme.

Co-authored-by: Adam Radestock <[email protected]>
Co-authored-by: RaddishIoW <[email protected]>
Co-authored-by: HarelM <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RaddishIoW RaddishIoW

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@HarelM @RaddishIoW