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

docs: rename and reorganize documentation files #165

Open
wants to merge 11 commits into
base: dev
Choose a base branch
from

Conversation

derpierre65
Copy link
Contributor

@derpierre65 derpierre65 commented Nov 22, 2024

this is the first step of the docs update

  • removed unused config.adoc file and moved the content to the real config.adoc file
  • fixed issues on the config page
  • add warning to icons, that the icons will not generated on a dedicated server
  • moved groups to read category, it's better to have a group of read and write endpoints, in the next steps i want to group the endpoints more
  • read/write index page has now a table with all available endpoints, for an easy search with the link to the page and a short description
  • warning for webhooks/websocket feature, that this is not yet re-implemented
  • removed old setCircuit docs, and will be re-implemented soon (as endpoint and docs)
  • new getSpaceElevator & getFactory view (i moved some rows into separate files to re-use them)

i will update the endpoints itself in the next pr(s)

i am absolutley not sure if everything is correct, i have never worked with adoc files before

here is an example from my editor of what the page should look like
grafik

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

Successfully merging this pull request may close these issues.

1 participant