The Dev Portal was created to replace our existing API Docs on the website. New Features:
- Searchable Docs
- Can view the current Swagger Docs for each of our Elements
- Docs are organized to support a more detailed explanation of Element/Product features
- e.g. Salesforce
- You can now send people to URLs and not worry about the side menu not opening or what not
- Semantic URLs
- All element docs live under
docs/elements
e.g/docs/elements/salesforce/index.html
- All prodoct docs live under
docs/products
e.g/docs/products/element-builder/index.html
- All element docs live under
Video of Quick and Dirty: Overview
The current version of our docs (http://cloud-elements.com/developer-documentation/) will be taken down on Sunday May 8th. The API DOCUMENTAITON link will be replaced with the new dev portal URL - (http://developers.cloud-elements.com/). (http://cl.ly/2v1q0f2u182A)
Customer Feedback:
- Current docs hard to navigate
- Scrolling through side menu was tedius
- Not searchable
Internal Reasons:
- Greg is updating API Doc HTML by hand
- The WordPress page has stopped rendering twice - this stresses Greg out very much
- Not all engineers able to contribute
- With new portal - it lives on GitHub and anybody can pull the repo down and contribute - much more collaborative
If you have any questions or feedback, please let me know. Your feedback is invaluable.
Thanks for the information at dev portal overview.