chore: Add docfx configuration for generating API documentation#28
chore: Add docfx configuration for generating API documentation#28kou merged 13 commits intoapache:mainfrom
Conversation
kou
left a comment
kou
left a comment
There was a problem hiding this comment.
Could you add a CI job that runs docf to https://github.com/apache/arrow-dotnet/blob/main/.github/workflows/test.yaml ?
I hope that it finds documentation failures.
There was a problem hiding this comment.
Is this a copy of the top-level RAEDME.md?
Can we refer this from the top-level README.md instead of having duplicated contents?
There was a problem hiding this comment.
It isn't a full copy, I removed some parts related to building and development to keep this more user focused.
I think once there is a live documentation website, we should remove the duplicated parts and put a link to the documentation in the README.
| *.sln | ||
| .github/pull_request_template.md | ||
| src/Apache.Arrow/Flatbuf/* | ||
| docs/images/* |
There was a problem hiding this comment.
I'm not sure what the rules are on which files can be excluded, but it seems unnecessary to have the licence header in an SVG?
Also, I should mention that favicon.svg was not created by me, I downloaded it from https://arrow.apache.org/visual_identity/ and just modified the height and width to fit in the header. Does this need to be documented anywhere?
There was a problem hiding this comment.
I'm not sure what the rules are on which files can be excluded, but it seems unnecessary to have the licence header in an SVG?
Yes.
Also, I should mention that favicon.svg was not created by me, I downloaded it from https://arrow.apache.org/visual_identity/ and just modified the height and width to fit in the header. Does this need to be documented anywhere?
It's not required by our logo guideline but could you add docs/images/README.md and add this note to the file for future changes? Can we exclude docs/images/README.md from the docfx targets?
Just to confirm, your size change doesn't violate the "Please don't visually distort the logos" part in https://arrow.apache.org/visual_identity/#using-the-logo , right?
There was a problem hiding this comment.
No it doesn't, I reduced the height to fit the header but have kept the aspect ratio the same.
There was a problem hiding this comment.
With the docs website open beside the Arrow website, I noticed the icons looked a bit different, so I've now copied the icon from arrow-site to use as the favicon and mentioned this in the README too.
This reverts commit 9eecf0c.
| *.sln | ||
| .github/pull_request_template.md | ||
| src/Apache.Arrow/Flatbuf/* | ||
| docs/images/* |
There was a problem hiding this comment.
I'm not sure what the rules are on which files can be excluded, but it seems unnecessary to have the licence header in an SVG?
Yes.
Also, I should mention that favicon.svg was not created by me, I downloaded it from https://arrow.apache.org/visual_identity/ and just modified the height and width to fit in the header. Does this need to be documented anywhere?
It's not required by our logo guideline but could you add docs/images/README.md and add this note to the file for future changes? Can we exclude docs/images/README.md from the docfx targets?
Just to confirm, your size change doesn't violate the "Please don't visually distort the logos" part in https://arrow.apache.org/visual_identity/#using-the-logo , right?
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2 participants
What's Changed
To generate and view the docs:
Closes #27.