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

Unwanted Getting Started Section #87

Open
BrianSidebotham opened this issue Jun 7, 2018 · 3 comments
Open

Unwanted Getting Started Section #87

BrianSidebotham opened this issue Jun 7, 2018 · 3 comments

Comments

@BrianSidebotham
Copy link

I know this repo is deprecated, but as it's your marked production one I'm putting the issue here.

I've come to build our project again and the documentation now has a large section called "Getting Started" which is full of empty boxes. This is the first thing people see when they're looking at the API documentation.

How can we remove this section? Is it in the default template, or is this something doca is choosing to generate. Is there something I can do in the schema to remove this documentation section?

In previous builds this wasn't present in the documentation.

image

@BrianSidebotham
Copy link
Author

Just as an update, both the events-api and node-docson templates don't show this getting started section and both look visually comparable to the default bootstrap theme.

@handrews
Copy link
Contributor

handrews commented Jun 8, 2018

@BrianSidebotham filing this issue here is totally appropriate! I should probably reword that deprecation notice a bit, I did the update in a bit of a rush on my way out the door for an extended sabbatical for the tech industry (obviously I'm still keeping my hand in somewhat, though!)

The intro section is explained in and controlled by the schema.js config file, under the assumption that a lot of people will probably look in there anyway. A PR putting some docs in a better place would be most welcome, or I'll probably get to it eventually.

If you would to have some section but change the contents, the file is app/src/client/introduction.js, as noted in the schema.js comment.

@ilexius
Copy link

ilexius commented Apr 6, 2019

I'm struggling to understand the connection between getting-started.json and introduction.js.
Maybe you can help me a bit. In introduction.js there is some content with articles, h2, and "Lorem ipsum" text. When generating the example, I can't see the "Lorem ipsum" anywhere. Were is it supposed to be displayed?
I was hoping to use this file to show some introduction content.

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

No branches or pull requests

3 participants