Repository navigation
chore: fix the install guide and delete unreachable code - #118
Merged
Merged
Conversation
When the 3D view became the published configurator, the dialog that mounted these files was deleted, but the files stayed. None is reachable by import from src/main.tsx, src/index.ts or any test: - GeneralConfig.tsx, RoofConfigurator.tsx, BuildingVisualization.tsx (which also held a second copy of the BuildingElementSource type) - StepperInput.tsx, scrollUtils.ts, surfaceFactory.ts, testingTasks.ts - demo_config.json, example_buem_response.json, example_building_node.json Four comments that pointed at the deleted dialog, GeneralConfig or BuildingConfiguratorProvider now name what replaced them.
docs/installing.md still showed the API before v0.4.0: a BuildingConfigurator dialog wrapped in BuildingConfiguratorProvider with a host HttpClient, a separate /experimental entry for the 3D view, and echarts as a peer dependency. None of those exist. The page now shows Building3DView mounted with the four ConfiguratorServices callbacks, lists its props and each service with its time budget, gives react, react-dom and three as the peer dependencies, and corrects the buildBuildingStates signature. The styling, geometry and storing sections are kept as they were.
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
1 participant
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.
Brings the install guide in line with v0.6.0 and deletes the files that stopped being reachable when the 3D view replaced the dialog.
What changes
docs/installing.mdshowsBuilding3DViewmounted with the fourConfiguratorServicescallbacks, lists its props and each service with its time budget, givesreact,react-domandthreeas peer dependencies, and corrects thebuildBuildingStatessignature. It no longer describesBuildingConfiguratorProvider, anHttpClient, the/experimentalentry orecharts, none of which exist.src/main.tsx,src/index.tsor any test:GeneralConfig.tsx,RoofConfigurator.tsx,BuildingVisualization.tsx(with its duplicateBuildingElementSource),StepperInput.tsx,scrollUtils.ts,surfaceFactory.ts,testingTasks.ts, and the fixturesdemo_config.json,example_buem_response.json,example_building_node.json.GeneralConfigorBuildingConfiguratorProvidernow name what replaced them.No behaviour change; no release needed.
Checks
npm test88/88,npm run typecheckclean,npm run build:libandvite buildsucceed.