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

Extend/provide user documentation #71

Open
DirkMahler opened this issue Feb 12, 2014 · 2 comments
Open

Extend/provide user documentation #71

DirkMahler opened this issue Feb 12, 2014 · 2 comments

Comments

@DirkMahler
Copy link
Member

There are already lots of interesting features but nobody knows how to use them - a comprehensive user documentation shall be provided explaining

  • core concepts of composite objects
  • mapping of entities, relations, queries
  • bootstrapping
  • use cases (e.g. CRUD, migrate)

etc.

@DirkMahler DirkMahler added this to the 0.3.0 milestone Feb 12, 2014
@DirkMahler DirkMahler self-assigned this Feb 12, 2014
@DirkMahler DirkMahler modified the milestones: 0.4.0, 0.3.0 Apr 10, 2014
DirkMahler added a commit that referenced this issue Apr 11, 2014
@Restage
Copy link

Restage commented May 23, 2014

I think enhancing the documentation is a very urgent task! I would really love to give something back and If you don't mind I could write down the experiences I got by playing around with your framework.
Is it ok for you If I start out by writing down how to setup a basic java project that uses XO in the Wiki? I guess it might be easier for you to review or maintain a documentation that to write everything on your own.

@DirkMahler
Copy link
Member Author

I'll extend the documentation during the next days with the steps to get started. May be the fastest start now would be using the wiki. But I'd prefer to maintain documentation within the project itself, the module doc/ already contains a sketch of an asciidoc document.

DirkMahler added a commit that referenced this issue May 26, 2014
DirkMahler added a commit that referenced this issue Jun 5, 2014
DirkMahler added a commit that referenced this issue Jun 23, 2014
@DirkMahler DirkMahler modified the milestones: 0.5.0, 0.4.0 Jun 23, 2014
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

2 participants