{"id":25729631,"url":"https://github.com/nforgeio/neon-doc","last_synced_at":"2026-05-14T11:40:41.148Z","repository":{"id":108699176,"uuid":"581971287","full_name":"nforgeio/neon-doc","owner":"nforgeio","description":"NEONFORGE public documentation","archived":false,"fork":false,"pushed_at":"2024-07-24T22:30:46.000Z","size":9002,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-07-25T00:28:33.295Z","etag":null,"topics":["neonforge","neonkube","neonsdk"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nforgeio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-25T05:21:15.000Z","updated_at":"2024-07-24T22:30:00.000Z","dependencies_parsed_at":"2024-05-02T02:33:30.859Z","dependency_job_id":"5b3f3f52-33ad-44c2-a025-76d90c1f8c0c","html_url":"https://github.com/nforgeio/neon-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nforgeio%2Fneon-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nforgeio%2Fneon-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nforgeio%2Fneon-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nforgeio%2Fneon-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nforgeio","download_url":"https://codeload.github.com/nforgeio/neon-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240777559,"owners_count":19855856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neonforge","neonkube","neonsdk"],"created_at":"2025-02-26T01:39:11.926Z","updated_at":"2026-05-14T11:40:36.100Z","avatar_url":"https://github.com/nforgeio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Useful Maintainer Information\n\nThis page describes how to configure your workstation to work with the NeonFORGE\ndocumentation as well as how to build and public it.\n\n## Maintainer Setup\n\nRun `~\\.buildenv.cmd` as administrator, which:\n\n* Configures some environment variables:\n\n  * **ND_ROOT:** references the local **neon-doc**  git repo folder\n\n  * **ND_SITE_ROOT:** references the local **nforgeio-docs/nforgeio-docs.github.io** folder\n\n  * **ND_NODEJS_VERSION** configures the version of Node.js we'll use to\n\trun the Docusaurus tools.\n\n  * **PATH:** Adds **~/toolbin** to the PATH so the documentation build script\n\tand related tools can be executed easily from the command line.\n\n* Checks for **nvm** installation and executes `~\\toolbin\\nvm-setup.exe` when\n  that's not already installed.  Answer YES if the installer asks to manage\n  any existing Node.js installations.\n\n* Installs the Docusaurus tools.\n\n## How this Works\n\nWe're using the open source [Docusaurus](https://docusaurus.io) project to generate\na static website from this repo and Microsoft's open source [docfx](https://github.com/dotnet/docfx)\ntool to generate API reference documentation from .NET code comments.\n\n\u003e **$todo(jefflill):** **docfx** code reference builds are currently performed manually\n\u003e after figuring out and addressing that, I'll need to document how that works here.\n\nOur documentation release process involves these GitHub repos:\n\n* **nforgeio/neon-doc (this repo):** non-SDK reference documentation source\n* **nforgeio-docs/nforgeio-docs.github.io:** GitHub Pages repo where the documentation is published\n\nThe build script (discussed below) runs the Docusaurus tool on the **nforgeio/neon-doc**\nlocal repository, generating the website files in the `~/build` folder and when plublishing\nto the public, the script replaces the website files in the **nforgeio-docs/nforgeio-docs.github.io**\nrepository and then commits and pushes the changes to GitHub, which will publish this to\nthe Internet after 10-30 minutes of processing.\n\n# Building and Publishing Documentation\n\nThe **neondoc-build** build scripts are located at `~/toolbin/neondoc-build.ps1` and `neondoc-build.cmd`,\nwith the PowerShell script doing all of the qwork and the Windows CMD script wrapping the\nPowerShell script making it easier to launch from the command line.\n\n```\n# Build the documentation to the [~/build] folder:\n\n```\n# Build docs without publishing:\nneondoc-build\n   \n# Build docs without publishing and without updating browser info:\nneondoc-build -skipBrowser\n   \n# Build and publish the docs:\nneondoc-build -publish\n```\n   \nThis has been integrated into our **neon-kube** build/stage/release tooling, where\ndocumentation will be built but not published during builds and staging and published\nonly after the GitHub release has been published.\n   \n**NOTE:** I've disabled the **deploy.yaml** GitHub action by renaming it because automatically\npublishing the site when commits are pushed doesn't really make sense; in general, we don't\nwant to publish documentation changes before the related software changes are public too.\n   \nIn cases where we need to publish corrections, we can just run this manually:\n   \n```\nneondoc-build -publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnforgeio%2Fneon-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnforgeio%2Fneon-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnforgeio%2Fneon-doc/lists"}