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

Documenting the project #20

Open
isobianin opened this issue Jan 24, 2021 · 2 comments
Open

Documenting the project #20

isobianin opened this issue Jan 24, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@isobianin
Copy link
Member

There are various potential routes to take in terms of making the project as open as possible. Here is the paraphrased information by Andre (amchagas) from the email chat we had the other day which can be implemented one by one in the following order:

  1. using instruments provided by github such as its own wiki;
  2. using git-page to create a welcome-page;
  3. register the project on hackaday to get more people interested/involved;

Having spent some time looking into it, I do not know how to correctly parallel this process and think that if we design a simple github-wiki and then add a welcome page, it will be a good way start the whole documentation process as for now it is pretty much consists of some random notes without a centralized 'database'.

@isobianin isobianin added the documentation Improvements or additions to documentation label Jan 24, 2021
@amchagas
Copy link
Member

Hi Ihor,
I think this approach is nice, the only thing I would watch out for is the possibility of exporting the documentation created on GH wiki. What I mean is: Is there a way to simply download all the documentation in case we want to port it to another platform and/or for instance edit it offline?

@amchagas
Copy link
Member

Nevermind! Just saw that one can clone the wiki locally. This solves my question

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

2 participants