Doc templates

[valentine94]

We have to figure out about a template for components

For this we need to know a basic elements of documentation which we need

[vladdancer]

Yea, you are right. I think we could start with this:

• Annotation
• Assertion
• Bridge
• Datetime
• DependencyInjection
• Diff
• Discovery
• EventDispatcher
• FileCache
• FileSystem
• Gettext
• Graph
• HttpFoundation
• PhpStorage
• Plugin
• ProxyBuilder
• Render
• Serialization
• Transliteration
• Utility
• Uuid

Each of them should be checked if it really is a component.

[valentine94]

Cool, but I'm just about a document structure for each component, e.g. signature, description, code etc.

[valentine94]

Then we can start to create a real doc files for the functions and components

[vladdancer]

Aha, ok. Let’s referes to the Dash app and examples from Drupal, Phalcon, Laravel, etc world.

On Jul 9, 2016, at 16:35, Valentine notifications@github.com wrote:

Cool, but I'm just about a document structure for each component, e.g. signature, description, code etc.

—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub #1 (comment), or mute the thread https://github.com/notifications/unsubscribe/AAwSFA1HMrW6K_jJDZEpqX_H0nPss6GEks5qT6OygaJpZM4JIniX.

[valentine94]

OK, so I'll install Dash now and check it out

[vladdancer]

I believe we can also teach ourselves and others by using principles that Hoa (http://hoa-project.net/En/Literature.html) used

Hoa insists on that we need to understand problems before to understand solutions. In fact, one of the goals of Hoa is to teach their users, because learning without understanding has no meaning and the experience shows that a comprehension of a problem paired with generic solutions provides better results

So each component has theory sections and also practical sections, sections that describes a components from practical point of view I think will be differ from component to component.
For example this component's sections http://hoa-project.net/En/Literature/Hack/View.html differs from http://hoa-project.net/En/Literature/Hack/Registry.html

[valentine94]

Hmm...sounds cool, but I think we have to start with more simple solution for the moment and then create this like a new feature.

What do you think?

[vladdancer]

The main difference between "Subsystem" and "Component" from developer's view that
Subsystem docs describes item from more verbate side and hides technical details given you a whole picture of sybsystem.
For example Drupal Config system (by CMI team) should describe in general: why what how. How is external api for communication with other custom/contrib (sub)systems/modules/plugins

[vladdancer]

What do you think?
You're right this is a base for all new.

But I'm talking about that section titles will be differ from component to component. I think we could have
service section, like:

• version
• tags
• subsystems (relations), or it could be covered by tags.
• link
• ?

[valentine94]

Looks good, are you able to create some example MD file, like I've did for functions?

[vladdancer]

I’ll try later today.

On Jul 9, 2016, at 17:02, Valentine notifications@github.com wrote:

Looks good, are you able to create some example MD file, like I've did for functions?

—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub #1 (comment), or mute the thread https://github.com/notifications/unsubscribe/AAwSFLZy20t4KVxQrU802wrDvC1_zGb2ks5qT6njgaJpZM4JIniX.

[valentine94]

OK, let's leave this pull request open until we'll finish with that point

[valentine94]

BTW, are you OK with a template for functions?