-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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: make DEVELOPING.md to be part of docs #2068
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM as the initial step.
But! IIUC, the page will contain two table of contents now. One generated by Jekyll and the other hand-written for people consuming this markdown file via GitHub.
Could you please disable the TOC generated by Jekyll via front-matter configuration? I think the trick is to add toc: false
, see https://loopback.io/doc/en/contrib/pages.html#frontmatter
--- | ||
lang: en | ||
title: 'Contributing code in LoopBack 4' | ||
keywords: LoopBack 4.0, contributing, community |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is "LoopBack 4.0" a known keyword? I mean do we need to register it somewhere in a YAML file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like most (if not all) docs pages are using LoopBack 4.0
. I searched for this term and 86 occurrences.
I didn't find any instructions about registering the keywords. Do you know how I can do that?
There are a few similar tasks on "Contributing to LoopBack", e.g. #1673.
This PR is to make
DEVELOPING.md
show up in the contribute side bar.https://loopback.io/doc/en/contrib/code-contrib.html
It has been ran locally. (Thanks @b-admike and @nabdelgadir!)