Add documentation to interoperate with personal portfolio #7
Conversation
This file contains 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
This is following the format expected by my [portfolio](https://github.com/sayandcode/portfolio/tree/feature/v2) i.e. with numbered screenshots accompanied by a _count.txt_ file serving as an index
The pictures used were also added to the documentation folder
Earlier we had sample values in .env.sample files. This is largely redundant due to the run-time typechecks and the associated schema definitions. Devs can just look at the schema definitions for the .env files, to understand what the data looks like. They don't need sample data
Earlier we were not using the dedicated CI-deployment script. This prevents failures in case of prompts by the CLI to confirm deployment, by accepting all prompts.
- The screenshot is now a full-width image with no visible alpha component. - The README now centers the embedded twitter post - The code snippet is wrapped around the line - The system diagram is made clickable for viewing in a separate tab
Using dvh causes a small amount of jittering when the address bar shrinks when the user scrolls. This can be perceived as a bug. To avoid this perception, we use small viewport height (svh) instead, so that user gets the full experience (full screen) even when the address bar is shown
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
ciflag)Why?
This helps us showcase this project on my portfolio
How?
The README files were updated as per the format required by my personal portfolio