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

Documents ver 2.0 #458

Open
15 of 19 tasks
kyasbal opened this issue Mar 28, 2017 · 0 comments
Open
15 of 19 tasks

Documents ver 2.0 #458

kyasbal opened this issue Mar 28, 2017 · 0 comments
Assignees

Comments

@kyasbal
Copy link
Member

kyasbal commented Mar 28, 2017

Official document should be written in English from now.

Guides will be translated at first.

This is the list of necessary documents.
All titles are temporary determined, should have more clear title.

Meta

  • Separate guide as essentials and some others part(ex. core-api) like document of Vue.js
    The essentials part can have document for some plugins beginner should know.

  • Tutorial section would be deleted and merged as Guide.

  • Contributor list should be maintained by manual.

Essential part

  • Installation
  • Introduction
  • GOML
  • Javascript interfaces
  • Components/Nodes/Converter
  • Important build-in tags
  • Important build-in components
  • Contribution guide

Core parts

  • Detail of grimoire interfaces
  • Detail of Goml/Node interfaces
  • Detail of Parsing goml
  • Detail of goml node
  • Detail of Messaging feature
  • The other references like NSIdentity, Constants and more.

Fundamental parts

  • Detail of structure of renderer
  • Detail of specifications for material
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants