Skip to content

Commit

Permalink
Final cleanups for documentation markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
javagl committed Feb 20, 2024
1 parent 68ec3f0 commit ee7e7a0
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ package-lock.json
/build
/dist
/data
/temp
/output
/specs/data/output
/specs/data/migration/output_gltf
Expand Down
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Change Log
==========

### 0.4.1 - 2024-mm-dd
### 0.4.1 - 2024-02-20

- The packages that have been introduced in version `0.4.0` have been merged back into a single package.
Details about the structure can be found in the [implementation notes](./IMPLEMENTATION.md).
Expand Down
2 changes: 1 addition & 1 deletion IMPLEMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Generating the documentation consists of two steps (which are subcommands of the
- extracting the API definitions from the build output
- generating the markdown from the API definitions.

The first step is performed by running `api-extractor` for each package individually. This happens from the top-level package JSON file, using the `--workspaces` parameter. The surface API information will be written into `./etc/<package>.md`. These files capture the public API, and changes in the public API will cause a warning to be printed
The first step is performed by running `api-extractor`. The surface API information will be written into `./etc/3d-tiles-tools.md`. This file captures the public API, and changes in the public API will cause a warning to be printed

> Warning: You have changed the public API signature for this project.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ When the tools are not installed as a package from NPM, but supposed to be used

After this, the tools can be executed using the same command line options as described above - for example:
```
npx ts-node .\packages\cli\src\main.ts gzip -i ./specs/data/TilesetOfTilesets/ -o ./output/TilesetOfTilesets-gzipped/
npx ts-node .\src\cli\main.ts gzip -i ./specs/data/TilesetOfTilesets/ -o ./output/TilesetOfTilesets-gzipped/
```

See the [implementation notes](IMPLEMENTATION.md) for details about the project structure.
Expand Down

0 comments on commit ee7e7a0

Please sign in to comment.