sitecrafting / conifer

:evergreen_tree: A powerful WordPress library plugin for OO development
https://www.coniferplug.in
MIT License
18 stars 2 forks source link

#17 squashing test/netlify commits for PR request #71

Closed philmprice closed 5 years ago

philmprice commented 5 years ago

Ticket: # 17

Updated pull request! (version 2)

I did a preliminary PR-squash into this new feature/documentation branch for easier reviewing (super cool!). I also reversed the lines that had erroneously been modified during debugging. Can you let me know if this one looks better?

Issue

The master branch currently only has the ability to generate static documentation from .md files. An update is needed to have the Conifer class doc blocks make their way to the static documentation site as well.

Solution

This update:

Impact

This update will persist class doc block markup through to the static documentation site.

Usage Changes

This update impacts the behavior of Netifly's automated static doc site build & "lando docs" tooling command. It is important to note that if an author adds a class & wants that class to show through in the documentation, they will need to add to the /docs/SUMMARY.md & /scripts/build-api-md.sh.

Considerations

It is worth noting that "lando docs" has an issue that prevents the process from fully completing. If we can smooth that out that'd be good. It is also worth noting that we can't ignore the intermediary "api reference" md files without negatively impacting the Netlify build process, so those may be hanging around in the repo even though they are meant to be overwritten on each build.

Testing

There are no tests associated with this PR.

acobster commented 5 years ago

Beautiful. Thanks @philmprice!

Building Markdown for traits is currently failing. Documented in #72.