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 wiki/readme #456

Open
six2dez opened this issue Jan 20, 2022 · 4 comments
Open

Improve wiki/readme #456

six2dez opened this issue Jan 20, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement

Comments

@six2dez
Copy link
Owner

six2dez commented Jan 20, 2022

  • Full docs revision
  • Add example scenarios to wiki
  • Desired tech requirements
@six2dez six2dez added documentation Improvements or additions to documentation enhancement labels Jan 20, 2022
@frost19k
Copy link
Contributor

frost19k commented Apr 4, 2022

I have devised a way to (very simply) configure the Docker Image as an axiom controller. Would you mind having a look at the readme here & letting me know if this is something you'd like to incorporate?

If so then I'll fork & make a PR.

@six2dez
Copy link
Owner Author

six2dez commented Apr 8, 2022

Yeah sure!

@frost19k
Copy link
Contributor

frost19k commented Apr 12, 2022

Okay, the changes are ready for PR.

We now have 3 option under Docker & the instructions are rather long. So I moved all but the basic instructions to the Wiki - rewriting that page entirely.

You can have a look at the new wiki page here

My PR will not include the Wiki - limitations of GitHub. How would you like to handle this?

Also, of course, inputs & criticisms of the new wiki - if you have any.

@six2dez
Copy link
Owner Author

six2dez commented Apr 12, 2022

I can update the Wiki right now and you can do a PR for the README.md by adding a reference to the wiki in the Docker section. If this works for you, just create the PR and I will accept and update the wiki at the same time. Remember to do PR to dev branch

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 enhancement
Projects
None yet
Development

No branches or pull requests

2 participants