Start documenting Servonk + suggested structure#25
Open
madb1lly wants to merge 35 commits into
Open
Conversation
Add dependencies for bindgen which don't appear to be included in Ubuntu 18.04, servo or B2G dependencies.
More info on Panasonic TVs, and added Redox OS following telegram discussion.
Add link to Panasonic source code.
Since GitHub already has a wiki section of each project it is ambiguous to refer to the "wiki" in the general sense, because people may think we mean the GitHub wiki section instead of another wiki.
Add work in progress devices - macOS and Flame.
Descriptions of rust-toolchain, bootstrap.sh and update-servo.sh.
Merge patch 4 with master
Update my master with Fabrice's
Update readme.md
Revert "Update readme.md"
Open
Contributor
Author
|
@fabricedesre What's is your opinion on the contributions to the docs written by @novski and me? |
fabricedesre
requested changes
Oct 3, 2018
fabricedesre
left a comment
fabricedesre
left a comment
Owner
There was a problem hiding this comment.
Thanks for doing that, it's awesome!
I would not include the files that are just place holders "This will describe..." though. I you want to keep track of what needs to be documented, why not open an issue or add them to the todo.md file?
Contributor
Author
|
@fabricedesre I've made the changes, thanks for the detailed check. The placeholder files are intended to set some structure to which others can contribute. If you prefer not to have a structure then I'll remove from my master branch and update the pull request. |
Contributor
Author
|
@fabricedesre I've removed the placeholders, got them in a separate branch now. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@fabricedesre, @novski,
I started preparing a document structure for Servonk a while ago, I probably should have shared this with you earlier.
The main document I've worked on so far is Organisation.md, which will describe the project structure and key files within it. I'm writing it as I learn about and work out how Servonk is built and how it executes - I assume it will be helpful for others like me who are less knowledgeable than you.
Most of the files are currently empty, placeholders for things I think are important. You can compare against @novski's PR and see some overlap, mainly on building on/for Linux.
Feel free to reject the overall PR, I shared it with you mainly for information. Tell me what you think is useful and I'll try and make a PR containing only the files you request.
Cheers :)