Scully Utils documentation

scullyio / scully

The Static Site Generator for Angular apps

https://scully.io/

MIT License

2.55k stars 257 forks source link

Scully Utils documentation #1084

Open jorgeucano opened 4 years ago

jorgeucano commented 4 years ago

🗄️ Docs report

Description

In /docs/reference/scully-api/utils we have 8 titles without any documentation.

## httpGetJson

## getHandledRoutes

## setPluginConfig

## getPluginConfig

## findPlugin

## createFolderFor

## getMyConfig

## setMyConfig

🔬 Minimal Reproduction

What's the affected URL?**

Reproduction Steps**

Expected vs Actual Behavior**

📷Screenshot

🔥 Exception or Error

🌍 Your Environment

Browser info

Anything else relevant?

brleinad commented 4 years ago

@jorgeucano Are you currently working on this? If not, I can tackle this in the next few days.

SanderElias commented 4 years ago

@brleinad I'm pretty sure @jorgeucano has other obligations at this moment, so go ahead!

brleinad commented 4 years ago

Cool, thanks @SanderElias. Are there any guidelines for writing documentation? I couldn't find any.

I was planning on following the structure there is for ROUTESPLIT on https://scully.io/docs/Reference/scully-api/utils/. Usage along with a short description of the return values and an example for each of the utils.

I will submit a PR probably next week. I read the CONTRIBUTING.md and signed the CLA.

SanderElias commented 4 years ago

@brleinad Thanks! We don't have a style-guide and/or guidelines for documentation yet. (it is on my wish-list(#1114), alongside a lot of other things!)

Don't hesitate to DM me if you need any assistance getting up and running.

pjlamb12 commented 3 years ago

findPlugin was documented on #1180 and has been merged.