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

Improve documentation generally #29

Open
5 tasks
gunvirranu opened this issue Dec 17, 2022 · 0 comments
Open
5 tasks

Improve documentation generally #29

gunvirranu opened this issue Dec 17, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@gunvirranu
Copy link
Owner

gunvirranu commented Dec 17, 2022

The documentation in general could be improved.

  • The installation instructions are very general at the moment and assumes the reader is sufficiently familiar with build systems (CMake).
    • Make use of FetchContent_Declare more robust
    • Look into other common build systems. Would be nice to provide simple methods for those as well
  • Improve structure of README and Docs page
    • Make linking them better and completely reduce duplication. Docs for code-specific stuff, README for general info.
    • Explain some technical backstory
    • Ensure the problem statement is clear, and what it provides specifically (inputs: {TLE, time}, outputs: {state vector}, embedded)
@gunvirranu gunvirranu added the documentation Improvements or additions to documentation label Dec 17, 2022
@gunvirranu gunvirranu self-assigned this Dec 17, 2022
@gunvirranu gunvirranu changed the title Improve installation instructions Improve documentation generally Apr 7, 2023
@gunvirranu gunvirranu added this to the v2.0.0 milestone Jan 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant