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.

Sign up for GitHub

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

Jump to bottom

improve documentation (0.3.x) #110

Open
2 of 6 tasks
pietroppeter opened this issue Jul 10, 2022 · 0 comments
Open
2 of 6 tasks

improve documentation (0.3.x) #110

pietroppeter opened this issue Jul 10, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pietroppeter
Copy link
Owner

pietroppeter commented Jul 10, 2022 •
edited
Loading

some improvements that could be done after releasing 0.3 (leftovers from #103):
@pietroppeter pietroppeter changed the title imporove documentation (0.3.x) improve documentation (0.3.x) Jul 10, 2022
@pietroppeter pietroppeter mentioned this issue Jul 10, 2022
Merged
32 tasks
pietroppeter added a commit that referenced this issue Jul 11, 2022
@pietroppeter
improving docs for v0.3 + fix markdown backend (#103)
b37ec6d 
fixes #85 (last step before tagging and releasing)

- improve changelog
- make sure all important changes (recent and older) are documented

details:

- [x] improving changelog and integrating thanks in changelog
  - [x] 0.1
  - [x] 0.1.x
  - [x] 0.2
  - [x] 0.2.x
  - [x] 0.3
  - [x] move changelog to separate file
- [x] improve documentation for some of the recent changes (from 0.2.0 until now)
  - [x] stuff in 0.2.0 that went un(der)documented
    - [x] add list of command line options generated with `nbInit`
  - [x] changes in 0.2.x
    - [x] 0.2.2: nbFile
  - [x] other 0.3 improvements by Hugo #80
    - [x] nbRawOutput
    - [x] nbClearOutput
  - [x] release 0.3 stuff #81
    - [x] newNbCodeBlock
    - [x] newNbSlimBlock
    - [x] new nbTextWithCode that does read code
    - [x] example files.nim for File
  - [x] nbPython # 83
    - [x] nbInitPython and nbPython
  - [x] nim to javascript #88 - added a section
    - [x] nbCodeToJs (or by pieces nbInitToJs, addCodeToJs, addToDocAsJs)
    - [x] nbKaraxCode
  - [x] CodeAsInSource now the default:
    - [x] remove bullet point in API section
    - [x] add section "Code Capture"
  - [x] make sure to rerun nimble readme to have readme updated (currently missing the interactivity docs)
- [x] other changes
  - [x] turned off warning for unused imports in `nimib.nim` (#103)
  - [x] fix md output of index.nim (bug in markdown backend?)


- some other improvements that could be done later: #110
@pietroppeter pietroppeter added the documentation Improvements or additions to documentation label Jul 13, 2022
@pietroppeter pietroppeter mentioned this issue Nov 3, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pietroppeter