question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Build and publish docs in CI

See original GitHub issue

Since 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:closed
  • Created 5 years ago
  • Comments:14 (14 by maintainers)

github_iconTop GitHub Comments

2reactions
rudi-cilibrasicommented, Aug 6, 2018

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 to gh-pages here and it has worked great for years http://rudi-cilibrasi.github.io/zlibcomplete/ for free too

1reaction
webmaster128commented, Aug 8, 2018

looks like some of the links are broken https://iov-one.github.io/iov-core-docs/latest/iov-tendermint-rpc/index.html

Thanks, fixed. This was a github pages configuration, ignoring files tat start with _.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found