[docs] Add an index page which contains links to all examples #125 #126
Conversation
totallynotvaishnav
force-pushed
the
issues/125-add-index-page
branch
from
4a6615b
to
0cf840a
Compare
There was a problem hiding this comment.
Can you please update the README to mention these examples and provide instructions to anyone who may want to see these?
I am talking about: https://github.com/openwisp/netjsongraph.js/tree/gsoc22#install
I think we should rename that section something like "Install and run demo examples"
Can you also make the start command open the browser to the examples page as we have in wifi-login-pages (which opens the default organization)?
Should I update only that specific part?
We already have this. |
Yes for now. Do you think there's any other relevant part that needs to be updated?
Ok! |
I don't see any other parts now. |
totallynotvaishnav
added this to In progress
in [GSoC 22] netjsongraph.js
via automation
nemesifier
changed the title
totallynotvaishnav
force-pushed
the
issues/125-add-index-page
branch
from
625ed24
to
93cea45
Compare
| ...JSONData, | ||
| nodes, | ||
| links | ||
| })); |
There was a problem hiding this comment.
--skip-checkendline is disabled and hence not complaining about this but we should maintain consistency across openwisp modules and ensure files always have an ending new line.
There was a problem hiding this comment.
I copied this from openwisp-wifi-login-pages. It is there to avoid checking end-lines for files in node modules. We already have insert_final_newline = true in .editorconfig to insert new line.
|
Screenshot |
There was a problem hiding this comment.
@totallynotvaishnav let's focus a bit on the text now, why is "LInk to demo ..." repeated each times? We know those are links to demos.
Also, I think the font of the links would be better a sans-serif font. Regarding the title "Basic examples" doesn't souond right to me, I think we should call it "Netjsongraph.js Example Demos" or something similar.
examples/index.html
Outdated
| </header> | ||
| <main> | ||
| <div class="cards"> | ||
| <a href="./netjsongraph.html" target="_blank">Link to netjsongraph base demo</a> |
There was a problem hiding this comment.
this could be just "Basic usage"
examples/index.html
Outdated
| <a href="./netjsongraph.html" target="_blank">Link to netjsongraph base demo</a> | ||
| </div> | ||
| <div class="cards"> | ||
| <a href="./netjsonmap.html" target="_blank">Link to netjsonmap base demo</a> |
There was a problem hiding this comment.
Is this the geo map? If yes, we could name it just "Geographic map"
There was a problem hiding this comment.
And so on for the other links.
|
Updated screenshot |
closes #125