Using a Bitbucket Wiki as app documentation

Question

Can a Bitbucket Wiki be used as user documentation? I.e. if I create a wiki which, in detail, describes how to use my app, can I add a link to the wiki on my website that my users can click on to lean how to use my app? Or would they need a Bitbucket/Atlassian account to view said wiki?

If it's possible for a user of my app to view my wiki without requiring a Bitbucket/Atlassian account, how do I enable the wiki to be viewable by the public. E.g. do I somehow need to "publish" it, or something? And then, where would I find the link that I'd then add to my website for my users to click on?

Ana Retamal · Accepted Answer

Hi Lee! You can definitely use the wiki as user documentation, even if your repository is private. There are different setups, depending on whether you want your repo to be private or public and if you want users to make changes to your wiki, you can find the options in the wiki page:

Then you can simply share the URL and they'll be able to visit it.

Let us know if you have any further questions!

Best regards,

Ana