feat(docs): restructure documentation into docs/ folder#46
Merged
gergely-szabo-sap merged 2 commits intomainfrom Apr 8, 2026
Merged
feat(docs): restructure documentation into docs/ folder#46gergely-szabo-sap merged 2 commits intomainfrom
gergely-szabo-sap merged 2 commits intomainfrom
Conversation
Move documentation from README.md into a dedicated docs/ directory with end-user-guides/ and contribution-notes/ subdirectories, aligning with the planned Docusaurus integration and sidebar structure. - Add docs/end-user-guides/: overview, getting-started, configuration, exporting-resources, widgets, subcommands, error-handling, sanitization, mkcontainer - Add docs/contribution-notes/: contributing guide (replaces running-with-nix.md) - Trim README.md to boilerplate, overview, and links to docs/ - Include _category_.json files for Docusaurus sidebar ordering
Contributor
Author
|
Related PR: SAP/crossplane-provider-docs#39 |
Update Nix flake inputs to their latest versions. Set markdownlint hook package to pkgs.markdownlint-cli to fix build after nodePackages was removed from nixpkgs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Move documentation from README.md into a dedicated docs/ directory with end-user-guides/ and contribution-notes/ subdirectories, aligning with the planned Docusaurus integration and sidebar structure.