trails icon indicating copy to clipboard operation
trails copied to clipboard

Task: describe the anatomy of trails

Open nrempel opened this issue 8 years ago • 5 comments

I'm hoping to dig in more and knock off some tasks soon once I find some time outside of work.

One barrier for me is understanding the anatomy of trails and how trailpacks interact with the system.

For example, what is the purpose of the archetype directory? lib? etc.

Maybe this is a good piece for the github wiki, or is there going to be a separate RTD site?

nrempel avatar Jan 08 '16 17:01 nrempel

I know I suggested back in the day on sails, that it would be great to have a developer google hangout where interested collaborators could get a walk through / tour from core devs. This could also help us to help them write the necessary documentation.

randallmeeker avatar Jan 08 '16 17:01 randallmeeker

I wrote a tutorial for trailpack (not working yet cause not all modules are on npm but it can help to understand) http://blog.jaumard.com/en/2016/01/06/create-a-trailpack-for-trails/ archetype are not part of this tutorial cause archetype are only use by yo generators for now. archetype is only template files that will be copy on trails project. Yo generator take the files and create your project with them.

Later all trailpack will be able to have there own archetype folder to share default config files for example

But yeah doc will come :)

jaumard avatar Jan 08 '16 17:01 jaumard

+1 for that

nrempel avatar Jan 08 '16 17:01 nrempel

+1

kokujin avatar Jan 24 '16 07:01 kokujin

Thx for the feedback

I am working on Anatomy & Concept & creating some videos about use cases. There is a lot of work to be done, but i am pretty sure that i will try everything possible to break all the devel's barrier.

If you wana ask some questions or discus if you think that something is missing on the docs there is two options: https://gitter.im/trailsjs/trails or Ask for a feature on :https://github.com/trailsjs/trails-docs/issues

maissani avatar Jun 10 '16 14:06 maissani