Wiki with documentation

[Hugo-Persson]

Could we open a Wiki for this project so we could start building up some documentation about what different functions work?

[dtslvr]

Hi @Hugo-Persson

Thanks for the input, I'm still undecided about your idea.

On the one hand, there is more and more functionality that users may not be aware of. On the other hand, I wonder if it makes sense to start an additional knowledge base that needs to be kept up to date in addition to the README, GitHub Discussions, FAQ and hints directly in the app (my preferred option).

How did you imagine the structure of the wiki?

[Hugo-Persson]

Maybe in-app hints better. I was thinking like a collection of how to do common actions. Like how to create manual asset. Or how scraper configuration works. How to add currency, real estate...

[Marketos-Damigos]

The readme and faq lack so much information regarding setting up the environment as well the functionality.

[The-Inamati]

I would second this. I just started the container and am struggling a lot to understand how to get this running in terms of configuration of the application itself not the container.

[unarmedpuppy]

I'm very interested in using this tool, self-hosted it to try it out, but I have absolutely no idea how I'm supposed to use any of the features. I can add cash accounts...but nothing else seem intuitive. Am I missing something obvious here to get started? Like adding my stock portfolios, other holdings, etc. A wiki or any documentation at all for how to use the tool would be helpful.

docker-compose down for now

[Marketos-Damigos]

I had the exact same reaction. The website barely gives any basic info and only guides you to the premium version, which still has zero documentation.

[diamant-x]

This needs to be high in the list. Currently there is not "get Started" page anywere. FAQ assumes you are already familiar with concepts from ghostfolio, and most of its answers are just too simple. Example: 'How to add other currencies' -> go to control panel, add currency. That's not much useful, How will future exchange rates be updated? Only manually? (Which is the only thing visible.
What are platforms? What is expected to be input in each field. It mentions yahoo somewhere around but even for that there's no example.

This could be an example of structure, but basically there needs to be a clear page defining all concepts in ghostfolio, including what they refer to in "real life" examples, and how they should be used.
And then another with tutorials on use cases "what should you do to track ETFs (from beginning to end)?" etc..

[colorcube]

I agree that a documentation is missing.

While it would be nice that the app itself gives more hints how to do things, I can't image how to include all the necessary information into a faq.

I see at least following topics:

• what does it do
• concepts
• usage (ui)
• examples/use cases
• custom setup (scraper config)
• updates

This would include useful information for self-hoster, but also for cloud users.

In my opinion, a faq can't include such information in a good way.

In github discussions I could imagine that the same questions are asked again and again, mostly because many of them don't include the full solution to a problem but only "works for me now".