Dynamic Documentation implementation best practices

There is a standard set of configuration changes for which we expect to maintain backward compatibility. Keep to those standard configuration changes to ensure an easy upgrade in the future.

When making changes to your Dynamic Documentation-based web application, you are encouraged to make sure the modifications are easy to maintain even after upgrades.

The list of basic configuration changes with backward compatibility includes:
  • Branding
  • Feature flags (toggle on/off)
  • Enabling/disabling widgets
  • Field configuration

If you decide to make changes that are not on this list, you are taking the risk that after upgrading to a newer version of Dynamic Documentation, the application no longer works, or no longer works as expected.