Project Databases: Build your own documentation for components

In a previous blog post, we showed you that documentation for methods has returned in the Explorer. Want to take things even further and use them as documentation for your components? In this blog post, we’ll show you how!

Share source code and documentation

Sharing component sources with project databases is very easy (e.g., via GitHub). To explain how to use them, documentation is essential. The documentation in the Explorer is saved in Markdown files, so you can use it to create documentation for your components.

If you use GitHub, you can create a mini-site for your documentation. Simply create a README file with a link to each method’s documentation. Then in your repository settings, activate GitHub page.

Voilà!

Compiled component AND DOCUMENTATION

When you build your component or compiled application with the “Build Application” dialog, the “Documentation” folder is automatically copied to the final project folder.

When a developer integrates your component into their database, they can directly see the documentation in the Explorer in 4D.