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.

Sign up for GitHub

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

Jump to bottom

Add wiki documentation to README for core config #466

Open
kirsty-hames opened this issue Nov 1, 2023 · 1 comment
Open

Add wiki documentation to README for core config #466

kirsty-hames opened this issue Nov 1, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kirsty-hames
Copy link
Contributor

Subject of the issue features

We currently don't have a process for documenting Core config and a lot of development goes undocumented due to this.

Taking steer from Vanilla, we should document settings as wiki pages and then itemise these in the README. See original discussion on this for reference - #408

I suggest we raise separate tickets for any settings that require documenting (creating the wiki page). And use this issue to keep track and populate the README? Please contribute with any suggestions and picking up documentation :)

Issues have already been raised for navigation settings and feedback image support
@kirsty-hames kirsty-hames added the documentation Improvements or additions to documentation label Nov 1, 2023
@kirsty-hames
Copy link
Contributor Author

Navigation wiki page created and currently being worked on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
adapt_framework: The TODO Board
Status: New
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kirsty-hames