Skip to main content

Write Documentation

Each component has a Documentation tab. If you feel that an explanation as to what that component is doing would help someone, fill it in here.

There is also a Show Information tick box on this tab. If you select this it shows to those reading the Route that there is information to read there for the component.

Documentation is always a chore so it makes sense to do it as you build. Filling in these Documentation tabs can really help others and is vastly less work than writing a complete document for each Route.

If you do have to write a document for each Route, these notes will help you when you come round to doing the documentation which there is seldom a great deal of time for when you are actually building Routes. Having these notes will save a lot of investigation for you and others in the future.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!