Commit Graph

42 Commits

Author SHA1 Message Date
Eugenio Romano
c3452a4f62 Documentation build (#6762)
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
2021-03-03 14:08:15 +00:00
Eugenio Romano
e2958b9988 update documentation 4.0.0 (#5968) 2020-08-10 18:06:51 +01:00
Eugenio Romano
ecca9220f1 Review Documentation and tools doc (#5600)
* add exclude files property

* remove Unknown

* fix reviewer

* Update reviewChecker.js

* Update docs/README.md

Co-Authored-By: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>

Co-authored-by: Mark Hulbert <39801222+m-hulbert@users.noreply.github.com>
2020-04-09 11:55:33 +01:00
Andy Stark
921fdc00df [ADF-4391] Doc review for 3.2 (#4601)
* [ADF-4391] Reviewed new clipboard class docs

* [ADF-4391] Reviewed new proc cloud class docs

* [ADF-4391] Reviewed new datatable doc additions
2019-04-12 16:18:43 +01:00
Andy Stark
cec08f50d7 [ADF-4249] Updates for doc review (#4494)
* [ADF-4249] Doc review updates

* [ADF-4249] Updated doc index pages

* [ADF-4249] Minor corrections to un/claim task docs
2019-03-26 10:18:44 +00:00
Andy Stark
5c63b7c0f8 [ADF-4252] Added doc link fixing tool (#4461)
* [ADF-4252] Added basic fixer for link and image URLs

* [ADF-4252] Added full check to link fixing tool

* [ADF-4252] Manually replaced http Github doc URLs

* [ADF-4252] Fixed rel note doc links with tool
2019-03-19 22:17:30 +00:00
Andy Stark
5fc05da7aa [ADF-4152] Updated folder structure of core docs (#4415)
* [ADF-4152] Moved core library docs into subfolders

* [ADF-4152] Moved core library docs into subfolders

* [ADF-4152] Manual fixes to core doc file links

* [ADF-4152] Further automatic + manual link tidying
2019-03-12 14:20:20 +00:00
Andy Stark
8b8f1e147f [ADF-4190] Fixed bad auto-generated URLs (#4413)
* [ADF-4190] Tool + config updates to fix Typedoc issues

* [ADF-4190] Added missing AppDefinitionRepresentation link
2019-03-08 13:29:06 +00:00
Andy Stark
e74f545aa8 [ADF-4152] Updated doc folder structure and index tool (#4403)
* [ADF-4152] Initial GraphQL implementation

* [ADF-4152] Schema updates

* [ADF-4152] Rounded out basic fields

* [ADF-4152] Added basic template functionality

* [ADF-4152] Added full template generation

* [ADF-4152] Moved proc services doc files to new folders

* [ADF-4152] Updated README.md with section from new template

* [ADF-4152] Fixed another problem with relative URLs

* [ADF-4152] Fixed links and some more bugs

* [ADF-4152] Removed proc services folder README file
2019-03-06 20:23:31 +00:00
Andy Stark
9915935714 [ADF-3745] Performed doc checks with tools (#4287)
* [ADF-3745] Fixed broken links

* [ADF-3745] Added broken link fix for version index

* [ADF-3745] Fixed issues caught by Markdown structure checker

* [ADF-3745] Fixed broken external links and their tool config
2019-02-07 16:34:46 +00:00
Andy Stark
a31803a6bb [ADF-3745] Added docs for remaining classes (#4277) 2019-02-06 19:07:20 +00:00
Andy Stark
947c55fbeb [ADF-4013] Fixed anchor generation in ToC doc tool (#4263) 2019-02-04 19:13:59 +00:00
Andy Stark
30b28889e1 [ADF-3745] Added Confirm dialog docs (#4193) 2019-01-25 10:38:22 +00:00
Andy Stark
54a1a90083 [ADF-3745] Updates for doc review (#4203) 2019-01-23 18:46:13 +00:00
Andy Stark
27adae8e1e [ADF-3745] Added docs for proc cloud services (#4183) 2019-01-18 14:30:34 +00:00
Andy Stark
fdded83699 [ADF-3745] Added docs for the new pipes (#4178)
* [ADF-3745] Added docs for the new pipes

* [ADF-3745] Added cont services readme file

* [ADF-3745] Added group initial pipe to type name exceptions
2019-01-17 17:22:04 +00:00
Andy Stark
ad5dcfe7c3 [ADF-3909] Updated references to JS-API in docs (#4176)
* [ADF-3909] Updated references to JSAPI classes in docs

* [ADF-3909] Removed obsolete Document library model doc page

* [ADF-3909] Updated JSAPI import lines in code samples
2019-01-17 12:55:05 +00:00
Andy Stark
b32654b236 [ADF-3745] Updated properties and doc comments (#4134) 2019-01-14 19:19:08 +00:00
Andy Stark
78411fc365 [ADF-3745] Added docs for new core services (#4126) 2019-01-10 13:45:19 +00:00
Andy Stark
478b299960 [ADF- 3846] Started Extensions library docs (#4095)
* [ADF-3846] Added some doc comments and skeleton doc files

* [ADF-3846] Added basic docs for Extensions library

* [ADF-3846] Fixes to index pages

* [ADF-3846] Did tslint check and fixed error with doc comment
2018-12-21 17:46:03 +00:00
Andy Stark
0b1cfcf8fe [ADF-3820] Added Library dialog component docs (#4061) 2018-12-12 12:07:26 +00:00
Andy Stark
09a51a6500 [ADF-3809] Added file checker tool and updated doc files (#4052)
* [ADF-3809] Added file checker tool

* [ADF-3809] Updated doc files based on file checker report
2018-12-05 13:14:27 +00:00
Andy Stark
9fd564a78e [ADF-3801] Added source links for core docs (#4038) 2018-12-01 11:38:06 +00:00
Andy Stark
4b68c98007 [ADF-3801] Added source linking tool and updated content services docs (#4037)
* [ADF-3801] Added source linking tool

* [ADF-3801] Added source links to doc files
2018-11-30 11:59:36 +00:00
Andy Stark
0a394869f5 [ADF-3745] Updates for doc review (20-11-2018) (#3992) 2018-11-21 11:19:56 +00:00
Andy Stark
383b74151a [ADF-3745] Updates for doc review (#3989) 2018-11-20 02:03:20 +00:00
Andy Stark
7b3f400c48 [ADF-3745] Updates for doc review (#3965) 2018-11-14 14:23:14 +00:00
Andy Stark
89fcdec5ef [ADF-3745] Updates for doc review (#3963)
* [ADF-3745] Updates for doc review

* [ADF-3745] Updated tutorial index

* [ADF-3745] Updated document list doc page
2018-11-13 09:20:30 +00:00
Andy Stark
0ed5b2d5de [ADF-3551] Doc fixes for release (#3849)
* [ADF-3551] Fixed missing docs index pages and links

* [ADF-3551] Fixed link in datatable docs plus ToC tool update
2018-10-02 15:00:38 +01:00
Andy Stark
2c49de6070 [ADF-3514] Added transclusions sections to doc files (#3756)
* [ADF-3514] Added transclusion sections and guide page

* [ADF-3514] Updated tables of contents where needed

* [ADF-3514] Updated index files
2018-09-10 11:11:25 +01:00
Andy Stark
69d8ff147e [ADF-3323] Updated doc tools to use DocFX intermediate files (#3601)
* [ADF-3323] Moved source file parsing to main doc tool

* [ADF-3323] Moved source info classes

* [ADF-3323] Added doc YAML generator tool

* [ADF-3323] Added doc YAML/JSON source paths to gitignore

* [ADF-3323] Completed templates and template context code

* [ADF-3323] Added source paths and updated type linker

* [ADF-3323] Final fixes to templates and type linking

* [ADF-3323] Fixed filter for private and protected methods

* [ADF-3323] Content services docs after check and rebuild

* [ADF-3323] Updated docbuild script in package.json
2018-08-14 15:42:25 +01:00
Andy Stark
821916fbd7 [ADF-3279] Initial refactoring of doc tools (#3541)
* [ADF-3279] Added timing option

* [ADF-3279] Updated to keep md files in memory during processing

* [ADF-3279] Changed read phase to use stored Markdown trees

* [ADF-3279] Renamed tool functions and removed obsolete ones

* [ADF-3279] Added progress bar and better error message handling
2018-08-14 15:42:04 +01:00
Andy Stark
5a3ce3d299 [ADF-3230] Changes to stop doc tools from updating files unnecessarily (#3519)
* [ADF-3230] Added basic change detector to doc tools

* [ADF-3230] Updates to type linker to fix before/after inconsistencies

* [ADF-3230] Fixed comparison error caused by adjacent text blocks

* [ADF-3230] Added basic change detector to doc tools

* [ADF-3230] Updates to type linker to fix before/after inconsistencies

* [ADF-3230] Fixed comparison error caused by adjacent text blocks

* [ADF-3230] Modified props tool to remove spaces from union types

* [ADF-3230] Made ToC tool before/after state consistent
2018-06-22 13:24:38 +01:00
Andy Stark
58522d0722 [ADF-3198] Index and tutorial content review (#3500)
* [ADF-3198] Fixed glitches in doc index files and tools

* [ADF-3198] Reviewed new tutorial content and fixed index glitches

* [ADF-3198] Fixed host settings component brief description
2018-06-18 22:57:01 +01:00
Andy Stark
5b94d6e244 [ADF-3198] Updated index files + minor doc updates (#3482) 2018-06-13 16:06:33 +01:00
Andy Stark
992cd38216 [ADF-2824] Reviewed search docs for 2.4 (#3477)
* [ADF-2824] Moved search widget docs into separate pages

* [ADF-2824] Separated search widget page and added search filter service docs

* [ADF-2824] Updated new search docs with doc tools
2018-06-13 12:46:33 +01:00
Andy Stark
beeb7bd369 [ADF-3150] Moved all doc tool config settings to doctool.config.json (#3455)
* [ADF-3150] Moved undoc stoplist to doc config file

* [ADF-3150] Moved config to doctools.config.json and removed obsolete scripts
2018-06-08 00:22:50 +02:00
Andy Stark
28ba09897e [ADF-2764] Added new type linker features and applied them to core docs (#3442)
* [ADF-2764] Added basic support for composite and external types

* [ADF-2764] Added new type linker features and applied to core docs
2018-06-06 13:21:31 +02:00
Andy Stark
c8f04193c7 [ADF-2764] Updated doc files with latest script features (#3368)
* [ADF-2764] Updated doc files with latest script features

* [ADF-2764] Rebuilt full index instead of just content services index
2018-05-23 00:40:02 +01:00
Andy Stark
0e64efc4e2 [ADF-3040] Replaced doc template engine to fix whitespace issues (#3356) 2018-05-21 15:54:22 +01:00
Andy Stark
73bc62ae8f [ADF-2979] Updated doc tools to avoid erasing MD docs with blank JSDocs in services (#3347)
* [ADF-2979] Update to ignore blank JSDocs for method signature

* [ADF-2979] Finished adding blank JSDoc check for services
2018-05-18 14:30:26 +01:00
Andy Stark
60644d9917 [ADF-2969] Moved doc tools to new tools folder (#3314)
* [ADF-2969] Moved doc tools to new tools folder

* [ADF-2969] Added files missing from schematic

* [ADF-2969] Added missing files to schematic
2018-05-11 14:01:19 +01:00