specs: initialize the specs folder and site

celestiaorg / go-header

Go library with all the services needed to request, sync and store blockchain headers.

Apache License 2.0

17 stars 16 forks source link

specs: initialize the specs folder and site #111

Closed MSevey closed 9 months ago

MSevey commented 9 months ago

Overview

copying over the mdbooks spec structure from app and rollkit.

Checklist

[ ] New and updated code has appropriate documentation
[ ] New and updated code has new and/or updated testing
[ ] Required CI checks are passing
[ ] Visual proof for any user facing features like CLI or documentation updates
[ ] Linked issues closed with keywords

github-actions[bot] commented 9 months ago

PR Preview Action v1.4.4 :---: :rocket: Deployed preview to https://celestiaorg.github.io/go-header/pr-preview/pr-111/ on branch gh-pages at 2023-09-25 15:56 UTC

codecov-commenter commented 9 months ago

Codecov Report

Merging #111 (d81ebc3) into main (ab6c2f5) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #111   +/-   ##
=======================================
  Coverage   69.68%   69.68%           
=======================================
  Files          37       37           
  Lines        2939     2939           
=======================================
  Hits         2048     2048           
  Misses        744      744           
  Partials      147      147

gupadhyaya commented 9 months ago

@vgonkivs @Wondertan @renaynay i am planning to add some rough specs this week. this PR is just adding the template/skeleton for it.

Wondertan commented 9 months ago

Another reason to have a repository template @MSevey

MSevey commented 9 months ago

Another reason to have a repository template @MSevey

@Wondertan I'm not convinced a template repository is helpful. If anything it would add the additional step of needing to keep that template repo up to date with changes. For instance, if we had a template repo, we would still need to do this PR since you can't simply apply the template repo to an existing repo.

I could see a template repo being useful when the project is at the stage of many distributed teams building and contributing to different repos. Having the process of teams starting repos from a template would be helpful in ensuring consistency at the start. But even in that situation, naturally things will diverge and I'm not sure a template repo is the best process for maintaining best practices.

Wondertan commented 9 months ago

@MSevey, I thought Rollkit in this exact stage. There are new repos being created like go-da and celestia-da. As well as celestia will continue extracting common libs like for shares and blobs.