Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation duplication #73

Closed
6 tasks done
2xB opened this issue Sep 12, 2023 · 1 comment
Closed
6 tasks done

Documentation duplication #73

2xB opened this issue Sep 12, 2023 · 1 comment

Comments

@2xB
Copy link
Member

2xB commented Sep 12, 2023

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:

  • 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:

@2xB
Copy link
Member Author

2xB commented Nov 2, 2023

@2xB 2xB closed this as completed Feb 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant