Fossil Forum
Post: Adding project documentation
I have installed Fossil. Did the quick start.
I want to use Fossil for my project documentation using the Docs (embedded docs) option and internal forum for notes.
I am struggling to add docs to the repo. What I did so far:
- add a menu item Doc /doc * wideonly
- tried to add a wiki document to this folder by creating a wiki page /doc/test. No result
- tried to create a subfolder /doc in the repo folder and add a test.md file to the folder. No result.
My question is what should I do to get the /doc visible and how can I add documents to this page?
I have tried to find the right steps in the fossil documentation but I could not find it.
While there are ways to solve the problem along your chosen approach, the Fossil-native way is to use /dir instead. That's what "embedded docs" means: a folder of files that you fossil add and fossil ci into the repo, making them visible under /dir.
If you want an automatic index of docs, then you want the wiki, not embedded docs.
See the /doc help page. It displays files stored within the repository. If you want to use the built-in wiki instead, see /wiki. I think you might have mixed up the two styles of displaying content.
If you have created a wiki page named /doc/test, it will show up under /wiki?name=/doc/test. The actual /doc URLs only display files stored in the repository.
Thanks for the answers. I appreciate this.
I am a few steps further and be able to store docs. I think however to create wiki pages and make links on the home page.
The next step I am struggling with is to open fossil with althttpd using a cgi script. I followed the description on the Fossil help pages but so far no success. It will not start the repos. To be clean, I must perhaps open a new thread?
The next step I am struggling with is to open fossil with althttpd using a cgi script. I followed the description on the Fossil help pages but so far no success. It will not start the repos. To be clean, I must perhaps open a new thread?
Please do, but also show us precisely what you did, including "ls -la" listings of the relevant files. Both Fossil's project lead and myself host fossil exclusively as CGIs under althttpd (including this very forum), so we know it works.