Build and publish docs in CI
See original GitHub issueSince we do not want to store api docs in the repo (too big, change too often), we should create a nice place to host them.
For the beginning, we can request devs to generate locally, but this is a pain point and barrier to entry, which we want to make as easy as possible for anyone looking to build in the iov ecosytem.
yarn docs
in the main package will build them all, we need to think of a hosting strategy, and then link them from the READMEs, so all npm packages have a link to current docs (on master? last tag??)
Issue Analytics
- State:
- Created 5 years ago
- Comments:14 (14 by maintainers)
Top Results From Across the Web
How to build publish code documentation on GitLab
This article will show how to build TS documentation with GitLab CI & deploy it on GitLab pages. The advantage of this approach...
Read more >Deploying documentation to GitHub Pages with CI - CircleCI
Learn how to use your CI system to build and deploy your documentation to GitHub Pages, rather than pulling in an additional tool...
Read more >GitLab CI/CD
Learn how to use GitLab CI/CD, the GitLab built-in Continuous Integration, Continuous Deployment, and Continuous Delivery toolset to build, test, and deploy ......
Read more >Configuring CI/CD to generate and publish TechDocs sites
This document explains the steps needed to generate docs on CI and publish to a cloud storage using techdocs-cli . The steps here...
Read more >How to automate and publish docs in CI (github actions)?
I want to automate the build and publishing of the docs of an open source typescript project hosted on Github.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
yes the only problem with pushing to
gh-pages
or github pages is that the repo with source code gets so big and loses density. this can be remedied by simply pushing docs to a docs-only repo that is named the same as the subject of the docs but has a prefix or suffix added to the repo-name like-doc
. i push docs togh-pages
here and it has worked great for years http://rudi-cilibrasi.github.io/zlibcomplete/ for free tooThanks, fixed. This was a github pages configuration, ignoring files tat start with
_
.