diff --git a/TODO.md b/TODO.md deleted file mode 100644 index ee7c0cef4..000000000 --- a/TODO.md +++ /dev/null @@ -1,21 +0,0 @@ -# Task List For RIDDL - -## RIDDL Language Improvements -* Incorporate definitions of fast data flow: pipes, streamlets (input, output, flow) and their - piping connections (consumers & producers). -* Support entity messaging within handlers to allow for aggregated root entities passing "tell" - operations to aggregated entities as actors -* Allow entities and contexts to define functions with Gherkin style specification -* Support arithmetic numeric computations as part of boolean/logic expressions where ever they - occur (e.g. invariants) -* ~~Allow multiple named state specifications in an entity to allow entities that are finite state - machines with FSM state transitions specified in handlers~~ - -## Implement Hugo Site Translator -* Translate RIDDL AST to Hugo site source as .md files -* Generate diagrams to include in the Hugo site to include: context maps, sequence diagrams, - entity diagrams & ERDs, data flow diagrams for pipes & messages -* Create a riddl-hugo-theme that provides all the shortcodes and YW styling for generated docs. -* Allow and validate riddl-hugo-theme shortcodes in the documentation of definitions. - - diff --git a/config.toml b/config.toml deleted file mode 100644 index e6b6ee9d2..000000000 --- a/config.toml +++ /dev/null @@ -1,132 +0,0 @@ -######################## Hugo Configuration #################### - -# Configure GeekDocs -baseUrl = "https://example.com/" -languageCode = "en-us" -title = "Unspecified Site Title" -name = "Unspecified Project Name" -description = "Unspecified Project Description" -tags = ["docs", "documentation", "responsive", "simple", "riddl"] -min_version = "0.83.0" -theme = [ "hugo-geekdoc" ] - -# Author information from config -[author] - name = "Not Provided" - email = "somebody@somewere.tld" - homepage = "https://example.org/" - -# Required to get well formatted code blocks -pygmentsUseClasses = true -pygmentsCodeFences = true -disablePathToLower = true -enableGitInfo = true -pygmentsStyle = "monokailight" - -# Required if you want to render robots.txt template -enableRobotsTXT = true - - -# markup(down?) rendering configuration -[markup.goldmark.renderer] - # Needed for mermaid shortcode - unsafe = true -[markup.tableOfContents] - startLevel = 1 - endLevel = 9 -[markup.goldmark.extensions] - definitionList = true - footnote = true - linkify = true - strikethrough = true - table = true - taskList = true - typographer = true - - -[taxonomies] - tag = "tags" - -[params] - # (Optional, default 6) Set how many table of contents levels to be showed on page. - # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/) - # You can also specify this parameter per page in front matter. - geekdocToC = false - - # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc - # relative to your 'static/' folder. - geekdocLogo = "images/logo.png" - - # (Optional, default false) Render menu from data file in 'data/menu/main.yaml'. - # See also https://geekdocs.de/usage/menus/#bundle-menu. - geekdocMenuBundle = false - - # (Optional, default false) Collapse all menu entries, can not be overwritten - # per page if enabled. Can be enabled per page via `geekdocCollapseSection`. - geekdocCollapseAllSections = false - - # (Optional, default true) Show page navigation links at the bottom of each - # docs page (bundle menu only). - geekdocNextPrev = true - - # (Optional, default true) Show a breadcrumb navigation bar at the top of each docs page. - # You can also specify this parameter per page in front matter. - geekdocBreadcrumb = true - - # (Optional, default none) Set source repository location. Used for 'Edit page' links. - # You can also specify this parameter per page in front matter. - geekdocRepo = "" - - # (Optional, default none) Enable 'Edit page' links. Requires 'GeekdocRepo' param - # and path must point to 'content' directory of repo. - # You can also specify this parameter per page in front matter. - geekdocEditPath = "edit/main/src/main/riddl" - - # (Optional, default true) Enables search function with flexsearch. - # Index is built on the fly and might slow down your website. - geekdocSearch = true - - # (Optional, default false) Display search results with the parent folder as prefix. This - # option allows you to distinguish between files with the same name in different folders. - # NOTE: This parameter only applies when 'geekdocSearch = true'. - geekdocSearchShowParent = true - - # (Optional, default none) Add a link to your Legal Notice page to the site footer. - # It can be either a remote url or a local file path relative to your content directory. - geekdocLegalNotice = "/legal" - - # (Optional, default none) Add a link to your Privacy Policy page to the site footer. - # It can be either a remote url or a local file path relative to your content directory. - geekdocPrivacyPolicy = "/privacy" - - # (Optional, default true) Add an anchor link to headlines. - geekdocAnchor = true - - # (Optional, default true) Copy anchor url to clipboard on click. - geekdocAnchorCopy = true - - # (Optional, default true) Enable or disable image lazy loading for images rendered - # by the 'img' shortcode. - geekdocImageLazyLoading = true - - # (Optional, default false) Set HTMl to .Site.BaseURL if enabled. It might be required - # if a subdirectory is used within Hugos BaseURL. - # See https://developer.mozilla.org/de/docs/Web/HTML/Element/base. - geekdocOverwriteHTMLBase = false - - # (Optional, default false) Auto-decrease brightness of images and add a slightly grayscale to avoid - # bright spots while using the dark mode. - geekdocDarkModeDim = true - - # (Optional, default true) Display a "Back to top" link in the site footer. - geekdocBackToTop = true - - # (Optional, default false) Enable or disable adding tags for post pages automatically to the - # navigation sidebar. - geekdocTagsToMenu = true - - # (Optional, default 'title') Configure how to sort file-tree menu entries. Possible options are 'title', - # 'linktitle', 'date', 'publishdate', 'expirydate' or 'lastmod'. Every option can be used with a reverse - # modifier as well e.g. 'title_reverse'. - geekdocFileTreeSortBy = "title" -