Closed Dan-Staff closed 5 years ago
- Short intro for the README (General concept of fornax do, why, ...)
Hi, yes. The README is a placeholder at the moment mainly for internal benefit. Can you review the tutorial linked below? You should be able to view it in the browser on GitHub without using jupyter.
Then I will transfer that narrative to the README file if appropriate.
- I've run into a few conflicts in the environment.yml - I can have a closer look on Monday
Thanks, that's very helpful
- For me, from the README it doesn't become very clear how the target graph has to be defined
See point 1 above
- Explain the quick start results - Do you want to explain parameters like hopping distance, iterations, ...?
See point 1 above
Thanks for your help @danjust
Tutorial 2 looks great! Only 2 comments (apart from a general intro):
Also Tutorial 2: iron_man.svg currently doesn't exist
Also Tutorial 2: iron_man.svg currently doesn't exist
Can you double check that it's there now?
I think there's now enough documentation to start working on it in a more iterate way
@mattdean-digicatapult @danjust it would be very helpful if somebody could try building the docs on their machine
also I'd really appreciate some proof reading
make sure that you tell somebody if you're going to push changed to a Jupiter notebook as they are a pain to merge.
There are 388 unique characters in the dataset
Should be 399
typo in tutorial:
"If we were searching a larger graph we could use a search tree as an index, an external sting
matching service or database"
The copyright at the bottom of each page also says Daniel Staff
but should probably say something like Digital Catapult
notebook is broken, I'm trying to fix it
Cleaner more documented tutorial reordered to improve understanding. Additional diagrams. Better visualisation of the results. Sphinx documentation