Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: introduce schematics #2049

Closed
wants to merge 2 commits into from
Closed

Conversation

profanis
Copy link
Contributor

This PR has a dependency on #2032

@nx-cloud
Copy link

nx-cloud bot commented Sep 11, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 7d8d217. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 3 targets

Sent with 💌 from NxCloud.

@bundlemon
Copy link

bundlemon bot commented Sep 11, 2023

BundleMon (Integration Projects)

Unchanged files (1)
Status Path Size Limits
Main bundles(Gzip)
hello-world-ng15/dist-integration/main.(hash)
.js
63.95KB +1%

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@codeclimate
Copy link

codeclimate bot commented Sep 11, 2023

Code Climate has analyzed commit 7d8d217 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 95.9% (0.0% change).

View more on Code Climate.

Copy link
Member

@markwhitfeld markwhitfeld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about having a schematics page that has all of this info, and then the necessary sections link to that page?
Or we add a schematics page that could list the different schematics and link to these sections on these different pages.
I'm neither way on this. What do you think?

@profanis
Copy link
Contributor Author

What do you think about having a schematics page that has all of this info, and then the necessary sections link to that page? Or we add a schematics page that could list the different schematics and link to these sections on these different pages. I'm neither way on this. What do you think?

That was my first approach. I then put myself in the shoes of a newcomer and decided to change that. A newcomer will visit the documentation and will try to have NGXS in his/her application by following more or less a step-by-step flow.
Other than the newcomer, an experienced user might need to visit the documentation to refresh his/her memory of how to create, for example, an action. Will visit the Actions menu item to read more about that and see the details of the schematic.
Do you think that this is a valid concern?

@markwhitfeld
Copy link
Member

Then I am happy to keep it as is, but can we just add a Schematics page that just lists out the different schematics, and links out to the sections of the pages that you have listed.
PS. can you also change the summary page back to using the - instead of the * so that the change remains focused on what this PR needs 👍 (we can change the list representation in a later PR).

@profanis
Copy link
Contributor Author

Then I am happy to keep it as is, but can we just add a Schematics page that just lists out the different schematics, and links out to the sections of the pages that you have listed. PS. can you also change the summary page back to using the - instead of the * so that the change remains focused on what this PR needs 👍 (we can change the list representation in a later PR).

I have integrated gitbook on my fork to have a visual representation of what I am doing. I assume it auto changed the Summary page. I am reverting it back

@profanis
Copy link
Contributor Author

I am closing this PR since GITBOOK integration messed up my commits
New PR #2057

@profanis profanis closed this Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants