rewrite documentation

Ellomend
0
Ellomend
commented 2 years ago

first of all
superb project. im actually loving it. great work.

but documentation is little odd. it makes learning curve too steep.
maybe its me but i had to read configuration page multiple times and everytime was confused.
i had to resort to examples and had hard time to do initial configuration.
build, page load crashed unexpectedly with uninformative errors.

for example:

String that specifies page directory where dynamic content is being requested. This is required so that the page’s route path can be changed to match the content’s permalink configuration.

what ? directory ? why ? what page`s route ? what permalink configuration ? what has to match what ?
isnt it just like in another content generators just lists files on folders ?

Number that specifies the heading level that you wish to be converted to link anchors for navigation within the content’s body. Defaults to 1, so any H1 in a md file will be converted.

please mercy. is this getting started section ? what is heading level and how conversion to anchor links happening and why ?
how do i get list of my content markdowns on index vue ?

it goes on with more advanced stuff i hope you get the idea.
i dont mean to be rude its just… for newcomers please consider up and running section or something.
i think this is awesome project and with nice and easy docs it will just blow charts

Thanks for your work.

0
derevandal
50
derevandal
commented 2 years ago

@Ellomend hey bro, thanks for commenting here!
we all know that documentation is poor, but we are concentrate on fix "nuxtent" to "nuxt v1.0.0".
after this release, we'll focus on the documentation, okay?

0
alidcastano
1.7k
alidcastano
commented 2 years ago

hi @Ellomend

fresh eyes are best for improving docs. if you understand module better now, maybe you can help explain it in a way that would be simpler 👍

0
chadananda
0
chadananda
commented a year ago

For example, the 'page' field (which indicates which .vue file will be responsible to display this content type) is described in the docs as "specifies page directory". ;) That will surely throw anyone off the trail. The only way to recover productivity is to read the description of the same field at nuxtdown-module fork:

page: This is the Nuxt page that will serve the dynamic routes to your content. As such, it's always a file somewhere in app/pages that starts with an underscore (as that's how Nuxt knows it's for dynamic routes)

0
Informations
QuestionUnresolved
#c116 - Created 2 years ago