The Wayback Machine - http://web.archive.org/web/20201223144257/https://github.com/freeCodeCamp/devdocs/pull/1270
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

Add Elisp docs for version 26.3 #1270

Merged
merged 5 commits into from Nov 18, 2020
Merged

Add Elisp docs for version 26.3 #1270

merged 5 commits into from Nov 18, 2020

Conversation

@MasterEnoc
Copy link
Contributor

@MasterEnoc MasterEnoc commented Sep 9, 2020

Add Elisp docs

  • Tested the scraper on a local copy of DevDocs
  • Ensured that the docs are styled similarly to other docs on DevDocs
  • Added these files to the public/icons/your_scraper_name/ directory:
  • 16.png: a 16×16 pixel icon for the doc
  • 16@2x.png: a 32×32 pixel icon for the doc
  • SOURCE: A text file containing the URL to the page the image can be found on or the URL of the original image itself
MasterEnoc added 3 commits Sep 9, 2020
- Add elisp.rb, clean_html.rb and entries.rb
- Add elisp (emacs) images.

- Add elisp in about_tmpl.coffee file

- Add get_latest_version method to elisp.rb

- Add some cleanups to the html doc for style
  purposes

- Add _elisp stylesheet
@simon04
Copy link
Contributor

@simon04 simon04 commented Nov 14, 2020

I don't know anything about elisp and how its documentation is used.

As an outsider, I find the 928 alphabetical entries in the Elisp / Manual intimidating.
2020-11-14-125003

Would it make sense to group it (using the headings from the manual index)? –
2020-11-14-124607

The navigation links should probably be removed –
2020-11-14-124646

MasterEnoc added 2 commits Nov 14, 2020
- fix scraper due changes in the web page

- add better style
@MasterEnoc MasterEnoc requested a review from freeCodeCamp/devdocs as a code owner Nov 14, 2020
@MasterEnoc
Copy link
Contributor Author

@MasterEnoc MasterEnoc commented Nov 14, 2020

PR updates. This pr was initially for elisp 26.3, now elisp is on 27.1 version and the web page received some updates.

This scraper entries were inspired by the bash entries, both share similar approach since both are manual and api documentation.

Elisp has a lot of documentation due emacs. It is the main programming language of emacs and shares some emacs' documentation plus low level fuction that emacs' manual does not have.

Please review the devdocs entry and comment if it would be better to group as you commented.

@simon04 simon04 self-assigned this Nov 18, 2020
Copy link
Contributor

@simon04 simon04 left a comment

Thank you!

@simon04 simon04 merged commit eda5319 into freeCodeCamp:master Nov 18, 2020
1 check passed
1 check passed
Travis CI - Pull Request Build Passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.