jpawlowski/hass.tibber_prices
1
0
Fork 0
mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-30 05:13:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hass.tibber_prices/docs/developer
History
Julian Pawlowski 334f462621 docs: update documentation structure for Docusaurus sites 
Update all references to reflect two separate Docusaurus instances
(user + developer) with proper file paths and navigation management.

Changes:
- AGENTS.md: Document Docusaurus structure and file organization
- CONTRIBUTING.md: Add Docusaurus workflow guidelines
- docs/developer/docs/period-calculation-theory.md: Fix cross-reference
- docs/developer/sidebars.ts: Add recorder-optimization to navigation

Documentation organized as:
- docs/user/docs/*.md (user guides, via sidebars.ts)
- docs/developer/docs/*.md (developer guides, via sidebars.ts)
- AGENTS.md (AI patterns, conventions)

Impact: AI and contributors know where to place new documentation.
2025-12-07 16:59:06 +00:00
..
docs docs: update documentation structure for Docusaurus sites 2025-12-07 16:59:06 +00:00
src docs: Add BMC logo SVG file to the images directory 2025-12-06 02:35:39 +00:00
static docs: Add BMC logo SVG file to the images directory 2025-12-06 02:35:39 +00:00
.gitignore git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
docusaurus.config.ts docs: Add BMC logo SVG file to the images directory 2025-12-06 02:35:39 +00:00
package-lock.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
package.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
README.md git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
sidebars.ts docs(developer): add recorder optimization guide 2025-12-07 16:57:53 +00:00
tsconfig.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00

README.md

Website

This website is built using Docusaurus, a modern static website generator.

Installation

yarn

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.