[proposal] Parasails docs

[ivanlobster]

Hey guys!

You guys are doing an amazing work with the framework, so I thought about trying to give back a little bit to the community and asked some weeks ago @mikermcneil on Twiter DM's if a PR on the Parasails bit could be interesting. Mike did say that Madison (@MadisonHicks I presume?) had started working on it, so I will ping you as well.

I think I've gone a little bit too much into low-level details (seeing the rest of your docs at least), but the reason I did it like this is that it's what I would have like to read when I was first starting with Sails (which did coincide with my journey with Vue.js).

I've tried to explain how Parasails is connected to Vue (where to set the Vue Instance data, methods, where it gets mounted and how does Parasails know where to mount each file....), and how it is all connected to the sails generate page command.

But I have no idea if this is your vision for this part of the docs (lol) so feel free to correct me if it's the case! At the end I believe this is a great framework, and I want to be as accesible as possible for other people starting out like I was.

Regarding this first commit

I still need to do propre spell-checking, revision and verifying I didn't break anything styles-wise.

But I did want to PR it and show it to you guys early in case I'm doing / explaining something in a way you don't want me to!

Needless to say I'm super open to suggestions, revisions, chages, etc...

[sailsbot]

Thanks for submitting this pull request, @ivanlobster! We'll look at it ASAP.

In the mean time, here are some ways you can help speed things along:

• discuss this pull request with other contributors and get their feedback. (Reactions and comments can help us make better decisions, anticipate compatibility problems, and prevent bugs.)
• ask another JavaScript developer to review the files changed in this pull request. (Peer reviews definitely don't guarantee perfection, but they help catch mistakes and enourage collaborative thinking. Code reviews are so useful that some open source projects require a minimum number of reviews before even considering a merge!)
• if appropriate, ask your business to sponsor your pull request. (Open source is our passion, and our core maintainers volunteer many of their nights and weekends working on Sails. But you only get so many nights and weekends in life, and stuff gets done a lot faster when you can work on it during normal daylight hours.)
• make sure you've answered the "why?" (Before we can review and merge a pull request, we feel it is important to fully understand the use case: the human reason these changes are important for you, your team, or your organization.)

---

Please remember: never post in a public forum if you believe you've found a genuine security vulnerability. Instead, disclose it responsibly.

For help with questions about Sails, click here.

[rachaelshaw]

Hi @ivanlobster! thanks for taking the initiative to start documenting Parasails, I think that's an excellent idea. After taking a look, I'm kind of thinking it'd make sense to put this under the Tutorials section, rather than Concepts, since the first pass reads like a tutorial. What do you think? Would you mind updating the PR to live under that section, and we can go from there?

[ivan-prats]

Hey @rachaelshaw !

I completely agree, having a fresh read of the Pages.md it does feel way more like a Tutorial than a Concept. I put it there and named it something like Getting started with Parasails. If the name feels off to you just tell me and I will update it without any problems.

I would maybe keep the Introduction.md file in concepts > Parasails, and have in Concepts small entries explaining what the main features are (Pages, Components, Utilities...).

I just pushed a quick example of what I mean in the Pages.md file. I put a couple of lines: *TODO unless Rachel / Mike / any core team member says otherwise:*. If this structure / changes seem okey to you guys: I will take my time to properly redact them and commit again!

(I'm ivanlobster btw haha that was my work account but I will do the followup with this account, my personal one)