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(index.html): add getting started section #69

Merged
merged 27 commits into from
Jun 1, 2021
Merged

Conversation

marcoscaceres
Copy link
Member

@marcoscaceres marcoscaceres commented May 28, 2021

@marcoscaceres marcoscaceres requested a review from sidvishnoi May 28, 2021 07:06
@marcoscaceres
Copy link
Member Author

Actually, let me fix the linking here...

@marcoscaceres
Copy link
Member Author

marcoscaceres commented May 28, 2021

(not sure what's up with Prettier... but that's what it outputs for me locally 🤢)

@sidvishnoi
Copy link
Member

sidvishnoi commented May 28, 2021

I was wondering if we can create a docs/README.md, move abstract and getting started there, and then data-include it in index.html
That way, we can have it rendered in both places. Also, markdown is kinda nicer to write.

@marcoscaceres
Copy link
Member Author

marcoscaceres commented May 28, 2021

We can do the docs/README.md thing... will it still show up as the README for the repo itself?

@sidvishnoi
Copy link
Member

sidvishnoi commented May 28, 2021

will it still show up as the README for the repo itself?

Not in repo itself, but when someone visits docs folder in repo. We can maybe replace our README if this ads more value?
Lets start with docs/README.md.

@marcoscaceres
Copy link
Member Author

Ok, so we will have two README.md? That's ok, given we have...

Alternatively, we could just convert the respec file into markdown? What's the value in having the separate files .md files?

@sidvishnoi
Copy link
Member

README.md is more of an introduction to the repo. docs/ is actual documentation/user guide.

@sidvishnoi
Copy link
Member

I don't understand why my local spec-prod build pass with these docs but it fails here (that bad link that markup validator catches).

@sidvishnoi sidvishnoi merged commit 65b5e40 into main Jun 1, 2021
@sidvishnoi sidvishnoi deleted the getting_started branch June 1, 2021 10:27
github-actions bot added a commit that referenced this pull request Jun 1, 2021
SHA: 65b5e40
Reason: push, by @sidvishnoi

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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