docs: render typedoc documentation for the extension API #921
Conversation
|
Thanks for the contribution, @ryan-blunden! You should receive feedback on your pull request within a few days. If you haven't already, please read through the contributing guide, and ensure that you've signed the CLA. Did you run into any issues when creating this PR? Please describe them in an issue so we can make the experience better for the next contributor. |
There was a problem hiding this comment.
Sweet, could we host this on https://docs.sourcegraph.com/ ?
https://github.com/sourcegraph/docsite only serves Markdown now, but it could be made to serve static files from an npm package somewhat easily. The easier immediate solution is to use unpkg.com and publish the docs that way, though. (That is what @felixfbecker suggested and @ryan-blunden plans to do that.) |
felixfbecker
changed the title
|
Is this ready or WIP? |
|
It's ready as far as I'm concerned.
Next step is to publish this along with the npm module.
…On Sat, 10 Nov 2018, 9:14 am Felix Becker ***@***.*** wrote:
Is this ready or WIP?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<https://github.com/sourcegraph/sourcegraph/pull/921#issuecomment-437599544>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAIHlh3h_EmD7thW_sDHLKFo7EMufxLlks5utwl2gaJpZM4YXxn_>
.
|
|
I'm surprised that you had to pass no arguments to |
|
This is missing the typedoc.js file. I'll add this tomorrow.
…On Sat, 10 Nov 2018, 1:34 pm Felix Becker ***@***.*** wrote:
I'm surprised that you had to pass no arguments to typedoc at all
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<https://github.com/sourcegraph/sourcegraph/pull/921#issuecomment-437623056>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAIHliW6z8703wMhZJLMxlH9qwXMzgCfks5ut0ZrgaJpZM4YXxn_>
.
|
|
The
|
|
Looks great! Can you make the |
ryan-blunden
force-pushed
the
rb/extension-api-docs
branch
from
4239491
to
3f15c6e
Compare
|
I've got one more thing to fix, don't merge yet. |
|
This is now ready for final review. |
|
@ryan-blunden you should release a new version of the package so we can start linking to it :) |
Update YAML and JSON configuration specifications to reflect changes in [#921](sourcegraph/src-cli#921)
…command (#46397) * Update YAML and JSON config specs Update YAML and JSON configuration specifications to reflect changes in [#921](sourcegraph/src-cli#921) * Update examples with new `src validate` command * Fix formatting issues * Fix spelling
…alth check functionality (#921) * Refactor validate functionality into pkg To support expansion of the validate command, the current validate functionality will need to be moved to a new subcommand. * Use existing internal api package for graphql requests * Remove create first admin features * Refactor configuration structs to support multiple code hosts in future * Add cool emoji to output * Add insight test cleanup * Add env vars for Github access token Github access token is needed for new validate command. Add token to config. * Add 'src validate install' command * Move 'src validate' functionality into 'srv validate install' commmand to allow for more validate subcommands. * Change validation API to be more specific * Change SRC_GITHUB_TOKEN to only be read if needed for command * Update CHANGELOG.md * Add warning if SRC_GITHUB_TOKEN isn't set * An auth token is required for code hosts when using `src validate install`, warn user and exit if not set. * Remove unused deps * Separate tasks being performed * Add symbol search to default queries * Change default queries to use sourcegraph/src-cli repo instead of gorilla/mux
This addresses https://github.com/sourcegraph/sourcegraph/issues/739