Skip to content
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.

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

Aggregator docs need an upgrade #138

Closed
mhasself opened this issue Jun 4, 2020 · 0 comments · Fixed by #221
Closed

Aggregator docs need an upgrade #138

mhasself opened this issue Jun 4, 2020 · 0 comments · Fixed by #221
Labels
documentation Requires documentation
Milestone

Comments

@mhasself
Copy link
Member

mhasself commented Jun 4, 2020

Improvements coming in #137 ... but some organizational / accuracy issues should also be resolved:

  • The "Aggregator Agent" has a sub-section called "Aggregator Agent"...
  • Perhaps present the "standard" Agent description blocks (site config, docker... ) first, then add details about the file structure.
  • Refer to "spt3g_software" and "G3 Frames"
  • SO3G is not a modification of SPT3G file format. It's a schema that operates on (now) standard G3 frames. And better to reserve "so3g" for the library. Our HK format is called the "SO HK Format".
  • Reading the HK files is best done with methods from so3g.hk. Refer.
@mhasself mhasself added the documentation Requires documentation label Jun 4, 2020
@BrianJKoopman BrianJKoopman added this to the v0.7.1 milestone Aug 13, 2020
@BrianJKoopman BrianJKoopman modified the milestones: v0.7.1, v0.7.2 Oct 23, 2020
@BrianJKoopman BrianJKoopman modified the milestones: v0.7.2, v0.8.1 May 12, 2021
BrianJKoopman added a commit that referenced this issue Aug 26, 2021
I also rewrote some small segments and added links to resolve some points
from #138.

fixes #138
BrianJKoopman added a commit that referenced this issue Sep 7, 2021
I also rewrote some small segments and added links to resolve some points
from #138.

fixes #138
@BrianJKoopman BrianJKoopman linked a pull request Sep 10, 2021 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Requires documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants