Update Docs and Readme
ClosedPublic

Authored by rizzitello on Mar 12 2018, 2:58 AM.

Details

Summary
  • Fix Bug tracker
  • Update Patrick's email address
  • Add contrib file for contributor information
  • Add a section for building
  • Touch up the mainpage
  • Update Readme to use the newer docs and remove the older invalid data
Test Plan

1 Build Documents look at Main page, the Building section and the Contribution section
2 View https://github.com/sithlord48/atcore to see how the new readme will be displayed.

Diff Detail

Repository
R232 AtCore
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
rizzitello requested review of this revision.Mar 12 2018, 2:58 AM
rizzitello created this revision.
rizzitello edited the summary of this revision. (Show Details)Mar 12 2018, 3:06 AM
rizzitello edited the test plan for this revision. (Show Details)
rizzitello added a project: Atelier: AtCore.
rizzitello added a subscriber: Atelier: AtCore.
rizzitello updated this revision to Diff 29298.Mar 12 2018, 3:11 AM
rizzitello edited the test plan for this revision. (Show Details)
  • Remove unneeded %
rizzitello added inline comments.Mar 12 2018, 11:31 AM
doc/contrib.md
8 ↗(On Diff #29298)

Correct typo

You may wish to join us on [IRC] or [Telegram]

patrickelectric requested changes to this revision.Mar 12 2018, 11:42 AM
patrickelectric added inline comments.
doc/mainpage.md
30

I think that is necessary a second column between this two, showing that basic functionalities and print work with the firmware. Right now this appears that only firmwares with yes in the SD card work.

This revision now requires changes to proceed.Mar 12 2018, 11:42 AM
laysrodrigues requested changes to this revision.Mar 12 2018, 11:59 AM
laysrodrigues added inline comments.
README.md
149

"ateler" for "atelier"
Add Donate field: https://kde.org/donate/?app=atcore

doc/build.md
89 ↗(On Diff #29298)

qt.io

doc/contrib.md
14 ↗(On Diff #29298)

You can say that the person can run the astyle script if needed.

doc/mainpage.md
23
24

laysrodriguessilva@gmail.com

36

same as above

rizzitello added inline comments.Mar 12 2018, 12:13 PM
doc/contrib.md
14 ↗(On Diff #29298)

This should be auto run on commit. You are correct it should be mentioned but idk that in this list is a good place to put it.
I Will add somewhere in this block

doc/mainpage.md
30

How about these ?
Firmware | Basic Use | Access SD

36

Donation link

rizzitello added inline comments.Mar 12 2018, 12:32 PM
doc/mainpage.md
36
rizzitello updated this revision to Diff 29351.Mar 12 2018, 8:06 PM
rizzitello marked 12 inline comments as done.
  • rebase
  • various suggestions by lays and patrick
rizzitello updated this revision to Diff 29374.Mar 13 2018, 4:39 AM
  • Test client is gpl3.0 fixed in appdata
tcanabrava accepted this revision.Mar 13 2018, 1:42 PM
rizzitello updated this revision to Diff 29409.Mar 13 2018, 2:37 PM
  • fix link for docs.
patrickelectric accepted this revision.Mar 14 2018, 2:37 AM
patrickelectric added inline comments.
doc/mainpage.md
30

Yep.

rizzitello marked an inline comment as done.Mar 14 2018, 11:53 PM
rizzitello updated this revision to Diff 29550.Mar 15 2018, 1:21 AM
  • Update Lays' email
laysrodrigues requested changes to this revision.Mar 15 2018, 1:25 AM
laysrodrigues added inline comments.
doc/mainpage.md
24

My name is twice here haha

This revision now requires changes to proceed.Mar 15 2018, 1:25 AM
rizzitello updated this revision to Diff 29558.Mar 15 2018, 3:44 AM
  • Add more to contrib.md
  • Document Plugin Search in atcore object documents
rizzitello updated this revision to Diff 29559.Mar 15 2018, 3:48 AM
  • remove lays double entry
rizzitello updated this revision to Diff 29560.Mar 15 2018, 3:50 AM
  • Remove added spaces
rizzitello marked an inline comment as done.Mar 15 2018, 3:52 AM
This revision was not accepted when it landed; it landed in state Needs Review.Mar 15 2018, 3:56 AM
Closed by commit R232:08016e148a46: Fix bugtracker (authored by rizzitello). · Explain Why
This revision was automatically updated to reflect the committed changes.