- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 61
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
Prepare Good Readme , Installation documentation #113
Comments
Adding a bit more info about the documentation:
|
Reference to presentation that can be used for history/background of fAIr in readme file: https://docs.google.com/presentation/d/1kR2Gezh3yOhEZBSjtoJR37rJ1JX9Q3m6T43BO55puIU/edit#slide=id.g17a6951e02b_0_26 |
Thanks to those of you who joined the HOT Open Tech and Inno session earlier today where I talked about this specific issue! Some people asked about example of similar docs from other repo- FMTM is one you can use for reference, where we have used Wiki . Please comment on the issue if you are interested in collaborating and helping us with creating documentation! |
Hi @petya-kangalova and @kshitijrajsharma sorry for missing voluntary session again, think I finally found the documentation issue pages, are there currently a table for tracking what needs or not needs to be documented still? How can we slot ourselves in, do we create a temporary doc branches when writing readme etc... |
@chrischank Not yet ! Initial plan is to let user know all about fAIr what we trying to achieve and what our current position is ! We can start by creating fork / branch start with .md file , Can modify existing readme.md pr introduce new .md file whichever is easy to read when user lands to fAIr github repo ! |
I guess what you would want is a readme.md per application or module right with a template and then that readme.md is assigned to a volunteer or a staff to work on based on understanding of the existing code? |
looping in @neelimagoogly as she is currently working on the docs #127. The idea is to create them as Github Wiki Pages. I am speaking with Neelima at 13:00UTC today about this- @chrischank you're welcome to join if you're free to discuss collaborating on this. |
After discussion with @neelimagoogly and @chrischank we agreed to split into three issues: I am closing this one as work will continue in the above issues. |
This issue is about documentation plan is to prepare a best way to communicate what fair is what it does , its potential and current stage so that people landing to github will get the gist idea 💡 ! Also we can separate installation doc for developers, also we can explain other smaller modules that fair is using such as fair utilities
The text was updated successfully, but these errors were encountered: