Skip to content

Instantly share code, notes, and snippets.

@majames

majames/markdown-files.md

Last active September 19, 2019 20:43
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save majames/3228189a4927d5c02fc5699fd9f00c79 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save majames/3228189a4927d5c02fc5699fd9f00c79 to your computer and use it in GitHub Desktop.
Download ZIP
Audit of Kaggle in repo markdown documentation
Raw
markdown-files.md
  • ./README.md - some documentation about trouble shooting failed npm installs and links to Kaggle.Web/README and Kaggle.Web/docs/README.linux.md
  • ./Kaggle.Sdk/README.md - brief documentation related to creating a handler and exposing it to the frontend
  • ./Kaggle.Sdk/Competitions/README.md - contains links to other readmes in the repo related to competitions
  • ./Kaggle.Browser.Tests/README.md -
  • ./Kaggle.Services.Competitions/README.md - empty documentation, ignore

Typescript Markdown Files

  • ./typescript/configs/README.md - briefly describes that directory contains typescript configs
  • ./typescript/README.md - unify with Kaggle.Web/README.md and lift into root
  • ./typescript/playbooks/creating-workspace-package.md - lift into docs/frontend/
  • ./typescript/projects/fontawesome/README.md - non existent documentation 🚧
  • ./typescript/projects/sdk/README.md - brief documentation around consuming API clients 🚧
  • ./typescript/projects/kcli/README.md - ignore
  • ./typescript/projects/material/README.md - brief documentation 🚧
  • ./typescript/projects/material/src/storybook/Scaffold/README.md - weird documentation, can it be removed? 🔥
  • ./typescript/projects/components/README.md - brief documentation 🚧
  • ./typescript/projects/components/src/competitions/README.md - can we generalise this and then remove it? 🔥
  • ./typescript/projects/kcli-commands/README.md - ignore

Kaggle.Web documentation files

  • ./Kaggle.Web/Composition/README.md - cryptic, can it be removed? 🔥
  • ./Kaggle.Web/docs/README.linux.md - instructions for how to get going on cloudtop
  • ./Kaggle.Web/docs/webtier-development.md
  • ./Kaggle.Web/docs/frontend-development.md
  • ./Kaggle.Web/README.md - contains setup and build instructions, links to webtier-dev and frontend-dev readmes and contains random API client info (api client stuff should be moved elsewhere and copy README format used in @kaggle/web) 🚧
  • ./Kaggle.Web/docker/README.md - documents cloudtop commands for spinning containers up and down
  • ./Kaggle.Web/Views/Shared/KernelsListing/README.md - ignore
  • ./Kaggle.Web/Helpers/RateLimits/README.md - ignore

Root Level documentation files

  • ./docs/shared-components.md - out of date docs on Kaggle.Web/Views/Shared components
  • ./docs/javascript.md - out of date JS style guide docs
  • ./docs/storybook.md - out of date docs on using storybook
  • ./docs/react.md - basic react styling info
  • ./docs/styling.md - out of date docs on styling react components
  • ./docs/sdk.md - documents end to end creation of a gRPC service (including consumption on the frontend)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment