You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently there exist multiple public places of user documentation:
On the "gh-pages" branch
On the "main" branch in the Kassiopeia/Documentation folder
In the main README
As far as I can tell, the Doxygen-based documentation is worse than browsing the source at the moment, so we can also get rid of it and potentially do it again from scratch in the future. We should however keep the logos somewhere. So I suggest removing:
I think we should move everything to the "main" branch in the "Documentation" folder since there people expect to find documentation and if people look for documentation for an old version of Kassiopeia, there they will look first.
Btw. there exists KEMField/Documentation/manual/manual.pdf which may make sense to link in the documentation as something like "KEMField Developer's Guide". Maybe it can also be compiled to Markdown using Pandoc to integrate it into the main documentation. But I think that's a challenge to solve after the above.
Currently there exist multiple public places of user documentation:
Kassiopeia/Documentation
folderAs far as I can tell, the Doxygen-based documentation is worse than browsing the source at the moment, so we can also get rid of it and potentially do it again from scratch in the future. We should however keep the logos somewhere. So I suggest removing:
Documentation/{Reference,CMakeLists.txt}
{KEMField,KGeoBag,Kommon}/Documentation/{Reference,CMakeLists.txt}
I think we should move everything to the "main" branch in the "Documentation" folder since there people expect to find documentation and if people look for documentation for an old version of Kassiopeia, there they will look first.
Btw. there exists
KEMField/Documentation/manual/manual.pdf
which may make sense to link in the documentation as something like "KEMField Developer's Guide". Maybe it can also be compiled to Markdown using Pandoc to integrate it into the main documentation. But I think that's a challenge to solve after the above.If this is agreed on, here are suggested tasks:
gh-pages
andmain:Kassiopeia/Documentation/Reference
: Aligned documentation of main and gh-pages #79main:Documentation
: Documentation: moved gh-pages into main, added "Edit on GitHub" link #80main:Documentation
: Documentation: moved gh-pages into main, added "Edit on GitHub" link #80gh-pages
branch -- last commit: 501d247main:KEMField/Documentation/manual/manual.pdf
in the public documentationThe text was updated successfully, but these errors were encountered: