resonatecoop / documentation Goto Github PK

View Code? Open in Web Editor NEW

5.0 7.0 2.0 5.15 MB

Providing support for Resonate's core technology and surrounding ecosystem

Home Page: https://docs.resonate.coop

License: MIT License

JavaScript 75.36% TypeScript 11.49% CSS 13.15%

co-op co-operative cooperative docs documentation music resonate streaming

documentation's People

Contributors

Stargazers

Watchers

Forkers

peterklingelhofer malimccalla

documentation's Issues

Implement GitHub Actions: Auto-move new issues to the main project

Swagger docs

Implement/Import Swagger docs via https://github.com/PaloAltoNetworks/docusaurus-openapi-docs

Add downloaded repo `.md` files to `.gitignore`

Is your feature request related to a problem? Please describe.
Running yarn start downloads untracked MD files that we don't want to commit in this repository.

Describe the solution you'd like
Add these to .gitignore to help to ensure that these files are not committed to in this repository.

Add User API Documentation

Is your feature request related to a problem? Please describe.
Not all of Resonate's APIs are currently listed in the top right and bottom right.

Describe the solution you'd like
Add the User API to the links in the top right and bottom right.

Describe alternatives you've considered
#7

We will probably try Angolia DocSearch first.

Blocked Externally: Fetching from multiple `sourceBaseUrls` via `docusaurus-plugin-remote-content`

For reference: rdilweb/docusaurus-plugin-remote-content#40

Once this is supported, we should be able to use something like this configuration to achieve this:

  plugins: [
    [
      "docusaurus-plugin-remote-content",
      {
        name: "stream", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/stream/development/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/basics", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "website", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/website/develop/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/basics", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "id", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/id/develop/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/basics", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "user-api", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/user-api/master/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/basics", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "user-api-client", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/resonatecoop/user-api-client/master/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/basics", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "beam", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/simonv3/beam/main/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/ecosystem", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
      {
        name: "stream-app", // used by CLI, must be path safe
        sourceBaseUrl: "https://raw.githubusercontent.com/peterklingelhofer/stream-app/main/", // the base url for the markdown (gets prepended to all of the documents when fetching)
        outDir: "docs/ecosystem", // the base directory to output to.
        documents: ["README.md"], // the file names to download
      },
    ],
],

Add Edit This Page button

Add Edit This Page button to bottom left of each page, as seen on the Docusaurus docs.

Optimize repository list in `docusaurus.config.js`

Create object, both for this repository and remote repositories:

repository
defaultBranch
organization
readmeFileName
title? // defaults to repo name capitalized and replacing dashes with spaces if not provided

or at least, create a function for some of the behavior in modifyContent.

This will reduce duplication/redundant code.

GitHub link in navigation bar should be GitHub logo

Is your feature request related to a problem? Please describe.
GitHub link in navigation bar is currently text.

Describe the solution you'd like
GitHub link should be the GitHub logo, as seen in the Docusaurus documentation.

resonatecoop / documentation Goto Github PK

documentation's People

Contributors

Stargazers

Watchers

Forkers

documentation's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs