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.

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

[Epic] Code documentation overhaul #153

Closed
2 tasks done
orpheuslummis opened this issue Jan 28, 2022 · 2 comments
Closed
2 tasks done

[Epic] Code documentation overhaul #153

orpheuslummis opened this issue Jan 28, 2022 · 2 comments
Assignees
@orpheuslummis
Labels
documentation Improvements or additions to documentation epic Includes sub-issues

Comments

@orpheuslummis
Copy link
Contributor

orpheuslummis commented Jan 28, 2022 •
edited
Loading

  1. Ensuring all documentation comments and doc.go files are in the right format
  2. Generating the documentation with godoc

Relevant resources:

Child issues:
@orpheuslummis orpheuslummis added the documentation Improvements or additions to documentation label Jan 28, 2022
@orpheuslummis orpheuslummis self-assigned this Jan 29, 2022
@orpheuslummis
Copy link
Contributor Author

related to #154

This was referenced Mar 4, 2022
Closed
Closed
@orpheuslummis orpheuslummis added this to the DefraDB v0.3 milestone Mar 8, 2022
@AndrewSisley AndrewSisley changed the title Generation of go doc documentation [Epic] Generation of go doc documentation Apr 13, 2022
@AndrewSisley AndrewSisley added the epic Includes sub-issues label Apr 13, 2022
@AndrewSisley AndrewSisley mentioned this issue Apr 13, 2022
Closed
@jsimnz jsimnz modified the milestones: DefraDB v0.3, DefraDB v0.3.1 May 17, 2022
@orpheuslummis orpheuslummis changed the title [Epic] Generation of go doc documentation [Epic] Code documentation overhaul Jun 26, 2022
@orpheuslummis orpheuslummis mentioned this issue Jun 26, 2022
Closed
@orpheuslummis orpheuslummis modified the milestones: DefraDB v0.3.1, DefraDB v0.4 Sep 13, 2022
@orpheuslummis
Copy link
Contributor Author

Closing in favor of a new flow which is a per-release set of issues related to documentation: external code, README, ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@orpheuslummis orpheuslummis

Labels
documentation Improvements or additions to documentation epic Includes sub-issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Overhaul for documentation autogeneration sourcenetwork/defradb
3 participants
@orpheuslummis @jsimnz @AndrewSisley