You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "adamreeve (via GitHub)" <gi...@apache.org> on 2025/08/27 10:11:09 UTC
[PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
adamreeve opened a new pull request, #28:
URL: https://github.com/apache/arrow-dotnet/pull/28
## What's Changed
* Adds docfx configuration for API docs
* Copied README into docs/index.md to use as the landing page for the docs. I've removed dev/build related docs and added links into the API reference pages
To generate and view the docs:
```
cd docs
dotnet tool install -g docfx
docfx docfx.json
docfx serve _site
```
Closes #27.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312664018
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review Comment:
No it doesn't, I reduced the height to fit the header but have kept the aspect ratio the same.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312678393
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review 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 is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2305436185
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review 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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312687644
##########
docs/images/README.md:
##########
@@ -0,0 +1,14 @@
+This directory contains images used in the Apache Arrow .NET documentation.
Review Comment:
```suggestion
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Images
This directory contains images used in the Apache Arrow .NET documentation.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2305436185
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312688041
##########
docs/index.md:
##########
@@ -0,0 +1,151 @@
+---
+_layout: landing
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Arrow .NET
+
+An implementation of Arrow targeting .NET.
+
+See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
+for currently available features.
+
+# Implementation
Review Comment:
```suggestion
## Implementation
```
##########
docs/index.md:
##########
@@ -0,0 +1,151 @@
+---
+_layout: landing
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Arrow .NET
+
+An implementation of Arrow targeting .NET.
+
+See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
+for currently available features.
+
+# Implementation
+
+- Arrow specification 1.0.0. (Support for reading 0.11+.)
+- C# 11
+- .NET Standard 2.0, .NET 6.0, .NET 8.0 and .NET Framework 4.6.2
+- Asynchronous I/O
+- Uses modern .NET runtime features such as **Span<T>**, **Memory<T>**, **MemoryManager<T>**, and **System.Buffers** primitives for memory allocation, memory storage, and fast serialization.
+- Uses **Acyclic Visitor Pattern** for array types and arrays to facilitate serialization, record batch traversal, and format growth.
+
+# Known Issues
+
+- Cannot read Arrow files containing tensors.
+- Cannot easily modify allocation strategy without implementing a custom memory pool. All allocations are currently 64-byte aligned and padded to 8-bytes.
+- Default memory allocation strategy uses an over-allocation strategy with pointer fixing, which results in significant memory overhead for small buffers. A buffer that requires a single byte for storage may be backed by an allocation of up to 64-bytes to satisfy alignment requirements.
+- There are currently few builder APIs available for specific array types. Arrays must be built manually with an arrow buffer builder abstraction.
+- FlatBuffer code generation is not included in the build process.
+- Serialization implementation does not perform exhaustive validation checks during deserialization in every scenario.
+- Throws exceptions with vague, inconsistent, or non-localized messages in many situations
+- Throws exceptions that are non-specific to the Arrow implementation in some circumstances where it probably should (eg. does not throw ArrowException exceptions)
+- Lack of code documentation
+- Lack of usage examples
+
+# Usage
Review Comment:
```suggestion
## Usage
```
##########
docs/index.md:
##########
@@ -0,0 +1,151 @@
+---
+_layout: landing
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Arrow .NET
+
+An implementation of Arrow targeting .NET.
+
+See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
+for currently available features.
+
+# Implementation
+
+- Arrow specification 1.0.0. (Support for reading 0.11+.)
+- C# 11
+- .NET Standard 2.0, .NET 6.0, .NET 8.0 and .NET Framework 4.6.2
+- Asynchronous I/O
+- Uses modern .NET runtime features such as **Span<T>**, **Memory<T>**, **MemoryManager<T>**, and **System.Buffers** primitives for memory allocation, memory storage, and fast serialization.
+- Uses **Acyclic Visitor Pattern** for array types and arrays to facilitate serialization, record batch traversal, and format growth.
+
+# Known Issues
+
+- Cannot read Arrow files containing tensors.
+- Cannot easily modify allocation strategy without implementing a custom memory pool. All allocations are currently 64-byte aligned and padded to 8-bytes.
+- Default memory allocation strategy uses an over-allocation strategy with pointer fixing, which results in significant memory overhead for small buffers. A buffer that requires a single byte for storage may be backed by an allocation of up to 64-bytes to satisfy alignment requirements.
+- There are currently few builder APIs available for specific array types. Arrays must be built manually with an arrow buffer builder abstraction.
+- FlatBuffer code generation is not included in the build process.
+- Serialization implementation does not perform exhaustive validation checks during deserialization in every scenario.
+- Throws exceptions with vague, inconsistent, or non-localized messages in many situations
+- Throws exceptions that are non-specific to the Arrow implementation in some circumstances where it probably should (eg. does not throw ArrowException exceptions)
+- Lack of code documentation
+- Lack of usage examples
+
+# Usage
+
+Example demonstrating reading [RecordBatches](xref:Apache.Arrow.RecordBatch) from an Arrow IPC file using an
+[ArrowFileReader](xref:Apache.Arrow.Ipc.ArrowFileReader):
+
+ using System.Diagnostics;
+ using System.IO;
+ using System.Threading.Tasks;
+ using Apache.Arrow;
+ using Apache.Arrow.Ipc;
+
+ public static async Task<RecordBatch> ReadArrowAsync(string filename)
+ {
+ using (var stream = File.OpenRead(filename))
+ using (var reader = new ArrowFileReader(stream))
+ {
+ var recordBatch = await reader.ReadNextRecordBatchAsync();
+ Debug.WriteLine("Read record batch with {0} column(s)", recordBatch.ColumnCount);
+ return recordBatch;
+ }
+ }
+
+
+# Status
Review Comment:
```suggestion
## Status
```
We need to add one more heading level for sub sections.
##########
docs/index.md:
##########
@@ -0,0 +1,151 @@
+---
+_layout: landing
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Arrow .NET
+
+An implementation of Arrow targeting .NET.
+
+See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
+for currently available features.
+
+# Implementation
+
+- Arrow specification 1.0.0. (Support for reading 0.11+.)
+- C# 11
+- .NET Standard 2.0, .NET 6.0, .NET 8.0 and .NET Framework 4.6.2
+- Asynchronous I/O
+- Uses modern .NET runtime features such as **Span<T>**, **Memory<T>**, **MemoryManager<T>**, and **System.Buffers** primitives for memory allocation, memory storage, and fast serialization.
+- Uses **Acyclic Visitor Pattern** for array types and arrays to facilitate serialization, record batch traversal, and format growth.
+
+# Known Issues
Review Comment:
```suggestion
## Known Issues
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2305353821
##########
docs/index.md:
##########
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312690719
##########
docs/index.md:
##########
@@ -0,0 +1,151 @@
+---
+_layout: landing
+---
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Apache Arrow .NET
+
+An implementation of Arrow targeting .NET.
+
+See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
+for currently available features.
+
+# Implementation
+
+- Arrow specification 1.0.0. (Support for reading 0.11+.)
+- C# 11
+- .NET Standard 2.0, .NET 6.0, .NET 8.0 and .NET Framework 4.6.2
+- Asynchronous I/O
+- Uses modern .NET runtime features such as **Span<T>**, **Memory<T>**, **MemoryManager<T>**, and **System.Buffers** primitives for memory allocation, memory storage, and fast serialization.
+- Uses **Acyclic Visitor Pattern** for array types and arrays to facilitate serialization, record batch traversal, and format growth.
+
+# Known Issues
+
+- Cannot read Arrow files containing tensors.
+- Cannot easily modify allocation strategy without implementing a custom memory pool. All allocations are currently 64-byte aligned and padded to 8-bytes.
+- Default memory allocation strategy uses an over-allocation strategy with pointer fixing, which results in significant memory overhead for small buffers. A buffer that requires a single byte for storage may be backed by an allocation of up to 64-bytes to satisfy alignment requirements.
+- There are currently few builder APIs available for specific array types. Arrays must be built manually with an arrow buffer builder abstraction.
+- FlatBuffer code generation is not included in the build process.
+- Serialization implementation does not perform exhaustive validation checks during deserialization in every scenario.
+- Throws exceptions with vague, inconsistent, or non-localized messages in many situations
+- Throws exceptions that are non-specific to the Arrow implementation in some circumstances where it probably should (eg. does not throw ArrowException exceptions)
+- Lack of code documentation
+- Lack of usage examples
+
+# Usage
+
+Example demonstrating reading [RecordBatches](xref:Apache.Arrow.RecordBatch) from an Arrow IPC file using an
+[ArrowFileReader](xref:Apache.Arrow.Ipc.ArrowFileReader):
+
+ using System.Diagnostics;
+ using System.IO;
+ using System.Threading.Tasks;
+ using Apache.Arrow;
+ using Apache.Arrow.Ipc;
+
+ public static async Task<RecordBatch> ReadArrowAsync(string filename)
+ {
+ using (var stream = File.OpenRead(filename))
+ using (var reader = new ArrowFileReader(stream))
+ {
+ var recordBatch = await reader.ReadNextRecordBatchAsync();
+ Debug.WriteLine("Read record batch with {0} column(s)", recordBatch.ColumnCount);
+ return recordBatch;
+ }
+ }
+
+
+# Status
Review Comment:
Good point, fixed now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312687300
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review Comment:
```suggestion
docs/images/*.png
docs/images/*.svg
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2303707636
##########
docs/index.md:
##########
Review 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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2311866770
##########
.github/workflows/test.yaml:
##########
@@ -83,3 +83,14 @@ jobs:
- name: Test
shell: bash
run: ci/scripts/test.sh $(pwd)
+
+ docs:
+ name: Build Documentation
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ steps:
+ - name: Checkout
+ uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+ - name: Build documentation
+ shell: bash
+ run: ci/scripts/build_docs.sh $(pwd)
Review Comment:
Can we simplify the file name?
```suggestion
run: ci/scripts/docs.sh $(pwd)
```
##########
docs/docfx.json:
##########
@@ -0,0 +1,57 @@
+{
+ "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+ "metadata": [
+ {
+ "src": [
+ {
+ "src": "../src",
+ "files": [
+ "**/*.csproj"
+ ]
+ }
+ ],
+ "dest": "api",
+ "properties": {
+ "ProduceReferenceAssembly": "true"
+ }
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "**/*.{md,yml}"
+ ],
+ "exclude": [
+ "_site/**"
+ ]
+ }
+ ],
+ "resource": [
+ {
+ "files": [
+ "images/*"
+ ]
+ }
+ ],
+ "output": "_site",
+ "template": [
+ "default",
+ "modern"
+ ],
+ "globalMetadata": {
+ "_appFaviconPath": "images/favicon.svg",
+ "_appLogoPath": "images/favicon.svg",
+ "_appName": "Apache Arrow .NET",
+ "_appTitle": "Apache Arrow .NET",
+ "_appFooter": "© The Apache Software Foundation",
Review Comment:
Could you also add "year"?
```suggestion
"_appFooter": "© 2018 The Apache Software Foundation",
```
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review 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?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: Add docfx configuration for generating API documentation [arrow-dotnet]
Posted by "adamreeve (via GitHub)" <gi...@apache.org>.
adamreeve commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2312688163
##########
docs/images/README.md:
##########
@@ -0,0 +1,14 @@
+This directory contains images used in the Apache Arrow .NET documentation.
Review Comment:
Whoops, thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org