Comments (2)
README.md
Much of this should be migrated to the docs site, but we need to have something at the root level. Maybe a brief introduction and then links to the docs?
api/README.md
Move the API documentation to the docs site, and put the migrations and other internal details in code comments.
release-notes/README.md
Leave this where it is - it's just an index of all the different versions. We could consider moving all the release notes to the docs site at some point.
scripts/**/README.md
Leave these where they are.
sentinel/README.md
This is mostly outdated and I think should just be deleted.
shared-libs/search/README.md
This is internal API documentation so should be moved to the code as jsdoc comments.
shared-libs/transitions/src/lib/pupil/README.md
This is the readme of a library that we inlined and then modified, so it's irrelevant. Leave it where it is. One day I hope to replace it with the version in npm...
tests/scalability/README.md
Move this to the docs site. We should consider finding and moving all the testing resources (example) into the new docs site too as QA reference. Maybe this is a separate issue...
from cht-docs.
Updating issue to review, import and/or update all relevant docs from cht-core.
- README.md
- api/README.md
- release-notes/README.md
- scripts/conflicts/README.md
- scripts/poe/README.md
- scripts/po-editor-importer/readme.md
- sentinel/README.md
- shared-libs/search/README.md
- shared-libs/transitions/src/lib/pupil/README.md
- tests/scalability/README.md
from cht-docs.
Related Issues (20)
- include detailed upgrade notes on upgrading to a CHT 4.4+
- Add upgrade notes about not being able to upgrade from v 4.3 and lower to v 4.7 and higher HOT 4
- Update CHT reference documentation on partner pages.
- Change config.toml to hugo.toml and review `treshold` HOT 1
- Update Product Trio Activities in docs
- Update CHT training resources
- Right hand navigation partially hidden on very "short" pages
- 'Page_Feedback' disappeared after hugo and docsy upgrade HOT 4
- Update Telemetry entry for analytic target aggregates sidebar filter
- Image rendering issue after upgrade HOT 1
- Docker to k8s migration guide
- 'Building' section migration and grouping HOT 1
- Document how to deploy CHT Sync to production HOT 1
- Update Android documentation for Google Play signed app domain verification
- Fix broken mermaid charts due to docsy upgrade HOT 1
- Fix overlapped copy link on local install HOT 1
- Fix #navigation caused by upgrade HOT 1
- Update couch2pgdata documentation
- Update Supervision documentation for managing multiple areas
- subtitle Anchor links missing after hugo upgrade HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cht-docs.