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

Documentation feedback #211

Open
roll opened this issue Sep 12, 2022 · 0 comments
Open

Documentation feedback #211

roll opened this issue Sep 12, 2022 · 0 comments
Labels
general General improvements

Comments

@roll
Copy link
Member

roll commented Sep 12, 2022

Overview

From @pdelboca:

Livemark:
The Starting a Project section lead me to an error when trying to execute livemark start
. The error is No documents to build in the project. However, it did execute if I add the parameter of the index.md file to the command.
$ livemark --version
0.109.0
$ codium . # to create index.md and livemark.yml
$ livemark start
No documents to build in the project
$ livemark start index.md
[I 220911 10:37:41 server:335] Serving on http://localhost:7000/
[I 220911 10:37:41 handlers:62] Start watching changes
[I 220911 10:37:41 handlers:64] Start detecting changes
[I 220911 10:37:45 handlers:135] Browser Connected: http://localhost:7000/
[W 220911 10:37:45 web:2271] 404 GET /assets/favicon.ico (127.0.0.1) 0.99ms
2. In the Data Visualization section, is not clear where add that chart/code. It would be nice to say it's in the index.md . Also, copying and pasting the block code doesn't work since it uses ' instead of ` required for markdown.
Some Personal Opinions:
I don't find useful to have the Publish to Github tutorial so early in the process. For example the section Data Journalism gets you to the publish before even adding a chart or table. I think it adds some noise and context switch when people is trying to understand how to get a chart done.
Kinda the same with the Data Collection section. I was trying to get some chart/table for my data. I found it super interesting, but I was just trying to draw a chart, not the automate a pipeline for an example I haven't finished yet. (It' a more advanced topic, so maybe would be better to have it later in the docs?)

@roll roll added the general General improvements label Sep 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
general General improvements
Projects
Status: No status
Development

No branches or pull requests

1 participant