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

[Parent issue] Developer documentation #78

Open
aggregate1166877 opened this issue Dec 28, 2021 · 0 comments
Open

[Parent issue] Developer documentation #78

aggregate1166877 opened this issue Dec 28, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation parent issue Contains multiple subtasks

Comments

@aggregate1166877
Copy link
Collaborator

aggregate1166877 commented Dec 28, 2021

Subtasks

For now, while the project is small, all documentation TODOs will be listed here. As the project grows however, documentation TODOs will need to be raised as individual issues instead.

Tasks:

  • Document getting profile data (using both userProfile.cacheChangeEvent and userProfile.getCurrentConfig).
  • Document the shader creation process.
  • Spaceship modding docs are very out of date and no longer work. Needs updating (this is on hold until the modules system is implemented).
  • Document how to create a new profile sub-config JSON file that Cosmosis can understand.
  • Document the modding process.

Brief description

Documentation for contributors and modders.

Definition of done

This is a recurring task and will likely never close.

Full description

TBA

@aggregate1166877 aggregate1166877 added documentation Improvements or additions to documentation parent issue Contains multiple subtasks labels Dec 28, 2021
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 parent issue Contains multiple subtasks
Projects
None yet
Development

No branches or pull requests

1 participant