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

Started documentation overhaul with the Getting Started section #154

Merged
merged 10 commits into from
Jun 9, 2017
Merged

Started documentation overhaul with the Getting Started section #154

merged 10 commits into from
Jun 9, 2017

Conversation

romaninsh
Copy link
Member

@romaninsh romaninsh commented May 8, 2017 •
edited
Loading

READ DOC HERE: http://agile-ui.readthedocs.io/en/feature-documentation-restructure/

I have started re-writing documentation. Previously we were just adding patches, but now I'm starting it from the very beginning and making sure it's consistent, no references are lacking and that examples execute properly.

This PR may also depend on some other features in UI, for example:

Currently Array persistence does not work with Pagination. The UI layer should automatically detect capabilities of Persistance and disable search/pagination if persistence does not support these features.

@romaninsh romaninsh added in progress Clarity 🔍 Makes things easier to understand. Documentation 📚 Undocumented features refactor labels May 8, 2017
@DarkSide666
Copy link
Member

Great!
It's important to somehow mark these places in docs where you describe some not already implemented functionality. That way we can find that easier and fix docs when needed.

@romaninsh romaninsh mentioned this pull request May 11, 2017
Merged
@romaninsh
Copy link
Member Author

romaninsh commented May 11, 2017 •
edited
Loading

Must resolve #99

@romaninsh
Copy link
Member Author

I have narrowed it down to the following top topics:

  • Overview of Agile UI
  • Quickstart
  • Core Concepts
  • Components
  • JavaScript Mapping
  • Advanced Topics

@romaninsh romaninsh merged commit 31dd8f0 into develop Jun 9, 2017
@romaninsh romaninsh deleted the feature/documentation-restructure branch June 9, 2017 17:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DarkSide666 DarkSide666 DarkSide666 approved these changes

Assignees
No one assigned
Labels
Clarity 🔍 Makes things easier to understand. Documentation 📚 Undocumented features refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@romaninsh @DarkSide666