Creating Documentation

Anvil Q&A
1

I had created a app in anvil. I am stuck in creating document for my app. Can you help me in creating document for my app. share the steps please.

2

Welcome @i7ec053, would you mind clarifying what exactly document? Is it pdf?

3

A pdf Or word file, that should describe what we done in our app. Its like a entire file that process done in app.

4

If you are talking about adding documentation for your apps, Anvil doesn’t have an official tool for this purpose.

Here are some ideas:

  • In our apps we have a link with a question mark that opens a page of our internal wiki. The wiki is hosted in a managed server and is widely used in our company

  • If you don’t have a handy wiki, you could host your documentation in github, readthedocs or other hosting services

  • If you want to keep all, including the documentation, in your Anvil ecosystem, then you can build a second app to serve documentation pages for all your apps. I think the fastest way could be by using a rich text component that allows to show formatted text and include images. You could even make it fancier and include an online editor.

5

Thankyou so much for responding my query.