Skip to content

Documentation #5

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 23 commits into from
May 31, 2023
Merged

Documentation #5

merged 23 commits into from
May 31, 2023

Conversation

miczyg1
Copy link
Contributor

@miczyg1 miczyg1 commented May 29, 2023

No description provided.

@miczyg1
Copy link
Contributor Author

miczyg1 commented May 29, 2023

Some documents are still missing. I wanted to describe the high-level methodology (empty file is created as a placeholder) and some principles behind the classes structure (there is a pattern I have maintained across 4 classes) and how they work. I would like to write it down as well.

@macpijan macpijan self-requested a review May 31, 2023 08:51
macpijan
macpijan reviewed May 31, 2023
View reviewed changes
Copy link
Contributor

@macpijan macpijan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some first comments. Still reviewing .rst files.

macpijan
macpijan reviewed May 31, 2023
View reviewed changes
Copy link
Contributor

@macpijan macpijan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job overall. The stats and graphs looks nice.

One thing maybe I'm missing: how do we plan to show these results to the client? Let's say I release Dasharo for some platform today and want to present such report. Where do I host/present such report?

@miczyg1
Copy link
Contributor Author

miczyg1 commented May 31, 2023 •
edited
Loading

Good job overall. The stats and graphs looks nice.

One thing maybe I'm missing: how do we plan to show these results to the client? Let's say I release Dasharo for some platform today and want to present such report. Where do I host/present such report?

I was thinking to add a separate section per board in docs.dasharo.com in the supported hardware

miczyg1 added 23 commits May 31, 2023 12:43
@miczyg1
.gitignore: ignore pycache and binary files
a4c8c14 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
README.md: extend with general information
1aaf5e8 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
examples: add sample utility outputs
d0aec91 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Integrate sphinx
73d14c3 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
requirements.txt: add dependencies
20bbd11 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
coreboot.py: Add docstrings
8cc588b 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
README.md: add usage
4be1d4d 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
openness-score.py: Add docstrings
c78a9eb 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
uefi.py: Add docstrings
8aa3ac8 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Fix typos in docstrings
0e75109 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Separate utility source code
d0c6005 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Create autogenerated code documentation
7d2eff1 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Rename the module name per PEP-8 guidelines
9647e55 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
openness_score: Wrap docstrings, remove dots on first line
0ed8f35 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
openness_score/coreboot.py: fix documentation creation error
47887fa 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
docs/source: enabel private and special members docs
d211fc4 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
docs/source/index.rst: fill in the home page
9c6a1a1 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
Add live HTML preview
be8cd94 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
examples: update examples to recent format
33b77df 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
docs/source: add design and methodology documents
71e891c 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
docs/source: improve the layout of documentation
fa809b3 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
README.md: update sample link
fa66dc6 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1
docs/source/design.rst: finalize design rules
85e3987 
Signed-off-by: Michał Żygowski <[email protected]>
@miczyg1 miczyg1 mentioned this pull request May 31, 2023
Open
Base automatically changed from data_export to main May 31, 2023 15:21
@miczyg1 miczyg1 merged commit 85e3987 into main May 31, 2023
@miczyg1 miczyg1 deleted the documentation branch May 31, 2023 15:21
@miczyg1 miczyg1 mentioned this pull request May 31, 2023
Closed
@miczyg1 miczyg1 mentioned this pull request Jun 24, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@macpijan macpijan macpijan left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@miczyg1 @macpijan