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

v1.4.0 #113

Merged
merged 71 commits into from
Sep 13, 2024
Merged

v1.4.0 #113

merged 71 commits into from
Sep 13, 2024

Conversation

ciatph
Copy link
Owner

@ciatph ciatph commented Sep 13, 2024

  • Build class and scripts documentation using JSDoc, #43
  • Setup class documentation build with Node and Docker
  • Build and deploy class documentation on push to the dev branch
  • Refactor README - use details/summary elements
  • Create a FAQs section in the README, #111
  • Display class initialization in the diagram
  • Add a LICENSE file

ciatph added 30 commits September 12, 2024 03:59
@ciatph
feat: generate class docs, #43
5d30700 
* using jsdoc/minami/taffyb
* installed with
  npm install --save-dev jsdoc minami taffydb
@ciatph
feat: build and deploy docs to gh pages, #43
4000ba4
@ciatph
fix: gh yml typo
ef23c38
@ciatph
fix: use relative dir path
a4aab42
@ciatph
fix: include hidden files in upload artifact v4
cd4171b
@ciatph
fix: use the /docs path
8fe0d03
@ciatph
log directory paths
140edb7
@ciatph
chore: log the nv variable
bbce291
@ciatph
fix: wrap gh env variable in quotes
9505884
@ciatph
fix: wrap gh env variable in quotes
77ebb70
@ciatph
chore: remove version number jsdoc build
c798d2a
@ciatph
chore: commit backup of full jsdoc settings with version no.
c027e0b
@ciatph
chore: remove jsdoc devDeps
035e59f 
* restored package*.json files from dev@79d5791
* retained the generate-docs script
@ciatph
chore: update README - add generate-docs to available scripts
fccaef2
@ciatph
fix: update gh upload artifacts path
4c5cdca
@ciatph
fix: docs/ path; log output
98b3d4c
@ciatph
fix: use jsdoc-generated docs/ path
32ee524
@ciatph
chore: include README in docs build
29895ed
@ciatph
chore: include README in docs build - follow-up
5731bed
@ciatph
fix: broken diagram URL link
42378d1
@ciatph
fix: use gh-pages root directory path for diagram
d8613eb
@ciatph
fix: include arch diagram in jsdoc config
a8ec1ef
@ciatph
fix: docs diagram file name
4cf5db4
@ciatph
fix: copy diagram after docs build
4b747ae
@ciatph
fix: create /docs dir and copy diagram
c7e4684
@ciatph
wip: remove node_modules/.bin in generate-docs script
af8b6f0
@ciatph
wip: remove picture asset in jsdoc config
1f7e144
@ciatph
chore: install jsdoc deps from script
8f3ac21
@ciatph
chore: install jsdoc from script
ee42dec
@ciatph
fix: bash script permission
1186f31
ciatph added 29 commits September 12, 2024 23:26
@ciatph
docs: README - update manual docs build using node
17bfbf0
@ciatph
chore: exclude docs build files in .npmignore
de7381c
@ciatph
docs: add gh pages URL link to class docs
0c04cbb
@ciatph
docs: update README
e1a3738 
* use docker exec with root user in docs build
@ciatph
docs: test using details/summary elements
7d12c0b
@ciatph
docs: test using details/summary elements, adjust text
551318a
@ciatph
docs: use details/summary
348fd83
@ciatph
docs: use more details/summary in the README
7f16bf6
@ciatph
docs: README
e6ac5f8 
* remove internal links in the table of contents
@ciatph
docs: update README
bc83198
@ciatph
docs: update README
7637ebb
@ciatph
docs: update README
18ba9cc
@ciatph
chore: build and deploy docs on push to dev branch, #43
e80151f
@ciatph
Merge pull request #110 from ciatph/feat/ciatph-43-jsdocs
804f63e 
Feat/ciatph 43
@ciatph
docs: use correct jsdoc type annotations
d37c797
@ciatph
docs: update class member doc
93b97e1
@ciatph
feat: add faqs section in the README, #111
01e1c08
@ciatph
chore: add local link to similar libs
f297a93
@ciatph
chore: remove p tags
eeb0b7c
@ciatph
chore: update README
b463d7d
@ciatph
chore: update README
b3cca25
@ciatph
docs: display class initialization
f8e010f
@ciatph
docs: adjust diagram size
cbd7e26
@ciatph
docs: update README heading color
e56f599
@ciatph
docs: add anchor links for docs build, #43
971f53e
@ciatph
chore: bump version minor v1.4.0
2c211c8
@ciatph
Merge pull request #112 from ciatph/feat/ciatph-111
a5b8fa7 
Feat/ciatph 111
@ciatph
Create LICENSE
4f13742
@ciatph
chore: build and deploy class docs on publish of new releases
ac13450
@ciatph ciatph merged commit 01bc0b9 into master Sep 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ciatph