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

Transfer technical documentation from README.md to official docs (single-source-of-truth simplification) #95

Closed
tpmccallum opened this issue Aug 1, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tpmccallum
Copy link
Contributor

Hi,
A couple of tasks which can be achieved now that the official Bartholomew documentation is live (public).

  • Reduce the amount of pre-existing technical documentation in Bartholomew's README.md file.
  • Transfer technical content like commands, instructions on how to install/use and so forth, to the official docs site [1].

This will provide a single-source-of-truth approach for us and reduce effort (only update documentation in 1 place, as the software evolves). Thanks @vdice for the feedback/comment @ #77 (comment)

I have assigned myself buy please anyone feel free to jump in with any ideas/comments/feedback i.e. thanks @karthik2804 for pointing out the binary release point the other day @ #93 (comment) that comment was useful and thought provoking.

@tpmccallum tpmccallum added the documentation Improvements or additions to documentation label Aug 1, 2022
@tpmccallum tpmccallum self-assigned this Aug 1, 2022
@tpmccallum
Copy link
Contributor Author

#110 closes this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant