Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a draft outline to explore how to improve our documentation site #2925

Closed
wants to merge 1 commit into from

Conversation

raymondfeng
Copy link
Contributor

@raymondfeng raymondfeng commented May 20, 2019

Please review https://github.com/strongloop/loopback-next/blob/docs-improvement/docs/site/Site-improvement.md.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@dhmlau
Copy link
Member

dhmlau commented May 21, 2019

@raymondfeng, your proposal LGTM.
+1 on the separation of the high-level overview and deep-dive topics.

Capturing our discussion, I had a question about where the topics around the data layer would fit in. You mentioned there could be an extra section about "Data and service integration".

@kowsheek
Copy link

Further to the topics outlined, I'd propose a design update too, making the doc site more accessible. Drawing comparison to TypeScript or Nest and even the LB4 home site, there's a lack of UX on the doc site.

@raymondfeng
Copy link
Contributor Author

The proposal has been incorporated into #3164.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants